docs: document the staging branch and add reference to it
authorEmil Velikov <emil.velikov@collabora.com>
Wed, 7 Nov 2018 16:02:59 +0000 (16:02 +0000)
committerEmil Velikov <emil.l.velikov@gmail.com>
Thu, 15 Nov 2018 15:48:15 +0000 (15:48 +0000)
A while back we agreed that having a live/staging branch is beneficial.
Sadly we forgot to document that, so here is my first attempt.

Document the caveat that the branch history is not stable.

CC: Andres Gomez <agomez@igalia.com>
CC: Dylan Baker <dylan@pnwbakers.com>
Signed-off-by: Emil Velikov <emil.velikov@collabora.com>
Reviewed-by: Juan A. Suarez <jasuarez@igalia.com>
docs/releasing.html
docs/submittingpatches.html

index 87590b19301b4757a78ad9b746eee95cf98e4f31..e4c770f9186cc1e78a5833b4b18959e4891b755e 100644 (file)
@@ -21,6 +21,7 @@
 <li><a href="#overview">Overview</a>
 <li><a href="#schedule">Release schedule</a>
 <li><a href="#pickntest">Cherry-pick and test</a>
+<li><a href="#stagingbranch">Staging branch</a>
 <li><a href="#branch">Making a branchpoint</a>
 <li><a href="#prerelease">Pre-release announcement</a>
 <li><a href="#release">Making a new release</a>
@@ -212,6 +213,25 @@ system and making some every day's use until the release may be a good
 idea too.
 </p>
 
+<h1 id="stagingbranch">Staging branch</h1>
+
+<p>
+A live branch, which contains the currently merge/rejected patches is available
+in the main repository under <code>staging/X.Y</code>. For example:
+</p>
+<pre>
+       staging/18.1 - WIP branch for the 18.1 series
+       staging/18.2 - WIP branch for the 18.2 series
+</pre>
+
+<p>
+Notes:
+</p>
+<ul>
+<li>People are encouraged to test the staging branch and report regressions.</li>
+<li>The branch history is not stable and it <strong>will</strong> be rebased,</li>
+</ul>
+
 
 <h1 id="branch">Making a branchpoint</h1>
 
index b84f01c3b3702507a274244303e66eac18d0cb0e..3f97c941aa59528abc90a638713fdcc2bae54e11 100644 (file)
@@ -253,6 +253,9 @@ If you are not the author of the original patch, please Cc: them in your
 nomination request.
 </p>
 
+<p>
+The current patch status can be observed in the <a href="releasing.html#stagingbranch">staging branch</a>.
+</p>
 
 <h3 id="thetag">The stable tag</h3>