aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorEmil Velikov <[email protected]>2018-11-07 15:59:07 +0000
committerEmil Velikov <[email protected]>2018-11-08 16:05:06 +0000
commitede46c67ea35c076721aac0d1b751eb589e50629 (patch)
tree66e1c9efdbd99a83192b4124b751d8cac76ff76a
parentecb1bef8714ede7b3b5b00a62c749b4c1b722e1c (diff)
docs: document the staging branch and add reference to it
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 <[email protected]> CC: Dylan Baker <[email protected]> CC: Juan A. Suarez Romero <[email protected]> Signed-off-by: Emil Velikov <[email protected]> (cherry picked from commit 0a60708870e256432bdef1a22c98b09f83d8a440)
-rw-r--r--docs/releasing.html20
-rw-r--r--docs/submittingpatches.html3
2 files changed, 23 insertions, 0 deletions
diff --git a/docs/releasing.html b/docs/releasing.html
index 52e102207d1..c79a020efa7 100644
--- a/docs/releasing.html
+++ b/docs/releasing.html
@@ -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>
@@ -209,6 +210,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 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>
diff --git a/docs/submittingpatches.html b/docs/submittingpatches.html
index e5350bdb2cf..d7ea0a310db 100644
--- a/docs/submittingpatches.html
+++ b/docs/submittingpatches.html
@@ -251,6 +251,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>