[Mesa-dev] [PATCH 1/7] docs/releasing: format/style homogenization
Andres Gomez
agomez at igalia.com
Mon Mar 27 18:48:10 UTC 2017
Signed-off-by: Andres Gomez <agomez at igalia.com>
Cc: Emil Velikov <emil.velikov at collabora.com>
---
docs/releasing.html | 35 +++++++++++++++++++++++++++++++----
1 file changed, 31 insertions(+), 4 deletions(-)
diff --git a/docs/releasing.html b/docs/releasing.html
index fc7f2a5aff9..cd5794a656a 100644
--- a/docs/releasing.html
+++ b/docs/releasing.html
@@ -14,6 +14,7 @@
<iframe src="contents.html"></iframe>
<div class="content">
+
<h1>Releasing process</h1>
<ul>
@@ -28,6 +29,7 @@
<li><a href="#bugzilla">Update Bugzilla</a>
</ul>
+
<h1 id="overview">Overview</h1>
<p>
@@ -48,6 +50,7 @@ For example:
Mesa 12.0.2 - 12.0 branch, bugfix
</pre>
+
<h1 id="schedule">Release schedule</h1>
<p>
@@ -79,12 +82,14 @@ The final release from the 12.0 series Mesa 12.0.5 will be out around the same
time (or shortly after) 13.0.1 is out.
</p>
+
<h1 id="pickntest">Cherry-picking and testing</h1>
<p>
Commits nominated for the active branch are picked as based on the
<a href="submittingpatches.html#criteria" target="_parent">criteria</a> as
described in the same section.
+</p>
<p>
Maintainer is responsible for testing in various possible permutations of
@@ -101,33 +106,38 @@ release. This is made <strong>only</strong> with explicit permission/request,
and the patch <strong>must</strong> be very well contained. Thus it cannot
affect more than one driver/subsystem.
</p>
+
<p>
Currently Ilia Mirkin and AMD devs have requested "permanent" exception.
</p>
-
<ul>
<li>make distcheck, scons and scons check must pass
<li>Testing with different version of system components - LLVM and others is also
performed where possible.
</ul>
+
<p>
Achieved by combination of local ad-hoc scripts and AppVeyor plus Travis-CI,
the latter as part of their Github integration.
</p>
+
<p>
<strong>Note:</strong> If a patch in the current queue needs any additional
fix(es), then they should be squashed together.
<br>
The commit messages and the <code>cherry picked from</code> tags must be preserved.
</p>
+
<p>
This should be noted in the <a href="#prerelease">pre-announce</a> email.
+</p>
+
<pre>
git show b10859ec41d09c57663a258f43fe57c12332698e
commit b10859ec41d09c57663a258f43fe57c12332698e
- Author: Jonas Pfeil <pfeiljonas at gmx.de>
+ Author: Jonas Pfeil <pfeiljonas at gmx.de>
Date: Wed Mar 1 18:11:10 2017 +0100
ralloc: Make sure ralloc() allocations match malloc()'s alignment.
@@ -146,7 +156,6 @@ This should be noted in the <a href="#prerelease">pre-announce</a> email.
(cherry picked from commit ff494fe999510ea40e3ed5827e7818550b6de126)
</pre>
-</p>
<h2>Regression/functionality testing</h2>
@@ -154,11 +163,13 @@ This should be noted in the <a href="#prerelease">pre-announce</a> email.
Less often (once or twice), shortly before the pre-release announcement.
Ensure that testing is redone if Intel devs have requested an exception, as per above.
</p>
+
<ul>
<li><em>no regressions should be observed for Piglit/dEQP/CTS/Vulkan on Intel platforms</em>
<li><em>no regressions should be observed for Piglit using the swrast, softpipe
and llvmpipe drivers</em>
</ul>
+
<p>
Currently testing is performed courtesy of the Intel OTC team and their Jenkins CI setup. Check with the Intel team over IRC how to get things setup.
</p>
@@ -202,15 +213,18 @@ To setup the branchpoint:
Now go to
<a href="https://bugs.freedesktop.org/editversions.cgi?action=add&product=Mesa" target="_parent">Bugzilla</a> and add the new Mesa version X.Y.
</p>
+
<p>
Check that there are no distribution breaking changes and revert them if needed.
For example: files being overwritten on install, etc. Happens extremely rarely -
we had only one case so far (see commit 2ced8eb136528914e1bf4e000dea06a9d53c7e04).
</p>
+
<p>
Proceed to <a href="#release">release</a> -rc1.
</p>
+
<h1 id="prerelease">Pre-release announcement</h1>
<p>
@@ -224,18 +238,22 @@ release is made.
</p>
<h2>Terminology used</h2>
+
<ul><li>Nominated</ul>
+
<p>
Patch that is nominated but yet to to merged in the patch queue/branch.
</p>
<ul><li>Queued</ul>
+
<p>
Patch is in the queue/branch and will feature in the next release.
Barring reported regressions or objections from developers.
</p>
<ul><li>Rejected</ul>
+
<p>
Patch does not fit the
<a href="submittingpatches.html#criteria" target="_parent">criteria</a> and
@@ -341,6 +359,7 @@ AUTHOR (NUMBER):
Reason: ...
</pre>
+
<h1 id="release">Making a new release</h1>
<p>
@@ -348,18 +367,21 @@ These are the instructions for making a new Mesa release.
</p>
<h3>Get latest source files</h3>
+
<p>
Ensure the latest code is available - both in your local master and the
relevant branch.
</p>
<h3>Perform basic testing</h3>
+
<p>
Most of the testing should already be done during the
<a href="#pickntest">cherry-pick</a> and
<a href="#prerelease">pre-announce</a> stages.
-
So we do a quick 'touch test'
+</p>
+
<ul>
<li>make distcheck (you can omit this if you're not using --dist below)
<li>scons (from release tarball)
@@ -452,6 +474,7 @@ be empty (TBD) at this point.
<p>
Two scripts are available to help generate portions of the release notes:
+</p>
<pre>
./bin/bugzilla_mesa.sh
@@ -468,6 +491,7 @@ to be included in the release notes.
<p>
Commit these changes and push the branch.
</p>
+
<pre>
git push origin HEAD
</pre>
@@ -478,6 +502,7 @@ Commit these changes and push the branch.
<p>
Start the release process.
</p>
+
<pre>
../relative/path/to/release.sh . # append --dist if you've already done distcheck above
</pre>
@@ -516,6 +541,7 @@ docs/index.html to add a news entry. Then commit and push:
<h1 id="announce">Announce the release</h1>
+
<p>
Use the generated template during the releasing process.
</p>
@@ -528,6 +554,7 @@ As the hosting was moved to freedesktop, git hooks are deployed to update the
website. Manually check that it is updated 5-10 minutes after the final <code>git push</code>
</p>
+
<h1 id="bugzilla">Update Bugzilla</h1>
<p>
--
2.11.0
More information about the mesa-dev
mailing list