From 6b1e1e187e2bb37ccdf108cc0c65aefbf41d1516 Mon Sep 17 00:00:00 2001
From: Tony Theodore <tonyt@logyst.com>
Date: Sun, 23 Oct 2011 04:15:46 +1100
Subject: doc update: add stable branch guidelines

---
 doc/index.html | 54 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 54 insertions(+)

diff --git a/doc/index.html b/doc/index.html
index 408df25..6f2b968 100644
--- a/doc/index.html
+++ b/doc/index.html
@@ -462,6 +462,14 @@ USE_OSGPLUGIN(&lt;plugin2&gt;)
         </p>
     </dd>
 
+    <dt>Release Updates</dt>
+    <dd>
+        <p>
+        If you are experiencing problems with a release
+        (e.g. broken download links), try the 
+        <a href="#development">stable development branch.</a>
+    </dd>
+    
     <dt>Old Releases</dt>
     <dd>
         <a href="#history">History</a>
@@ -474,6 +482,45 @@ USE_OSGPLUGIN(&lt;plugin2&gt;)
 <h2 id="development">Development Version</h2>
 
     <p>
+    For the sake of simplicity, there are two development
+    branches - "default" and "stable". Although it might
+    seem obvious, here's an overview of the types of
+    changes that go into each branch:
+    </p>
+
+    <ul class="compact-list">
+        <li>
+            Any change in the build scripts goes into "default".
+        </li>
+        <li>
+            Any package upgrade goes into "default".
+        </li>
+        <li>
+            Any documentation upgrade that refers to a feature
+            not present in stable goes into "default".
+        </li>
+        <li>
+            Anything else that doesn't effect the build goes
+            into "stable".
+        </li>
+        <li>
+            Any non-critical improvement to the main Makefile
+            goes into "stable".
+        </li>
+        <li>
+            Any improvement in the package download URLs or
+            package version recognition goes into "stable".
+        </li>
+        <li>
+            When in doubt, use "default" rather than "stable".
+        </li>
+        <li>
+            After a successful testing phase, the whole "default"
+            branch will be merged (moved) into "stable".
+        </li>
+    </ul>
+
+    <p>
     To obtain the current development version,
     install
     <a href="http://mercurial.selenic.com/">Mercurial</a>
@@ -483,6 +530,13 @@ USE_OSGPLUGIN(&lt;plugin2&gt;)
     <pre>hg clone http://hg.savannah.nongnu.org/hgweb/mingw-cross-env</pre>
 
     <p>
+    The stable version can be obtained by:
+    </p>
+
+    <pre>hg clone -b stable \
+        http://hg.savannah.nongnu.org/hgweb/mingw-cross-env</pre>
+    
+    <p>
     To retrieve updates, run:
     </p>
 
-- 
cgit v0.12