Update docs: explain branch workflow

phdru · phdru · commit fcec95cc405a · 2017-03-07T22:32:57.000+03:00
diff --git a/devel/DeveloperGuide.html b/devel/DeveloperGuide.html
@@ -64,6 +64,7 @@ <h3><a href="index.html">Table Of Contents</a></h3>
 <li><a class="reference internal" href="#columns-validators-and-converters">Columns, validators and converters</a></li>
 </ul>
 </li>
+<li><a class="reference internal" href="#branch-workflow">Branch workflow</a></li>
 <li><a class="reference internal" href="#style-guide">Style Guide</a></li>
 <li><a class="reference internal" href="#testing">Testing</a></li>
 <li><a class="reference internal" href="#documentation">Documentation</a></li>
@@ -113,9 +114,10 @@ <h1>SQLObject Developer Guide<a class="headerlink" href="#sqlobject-developer-gu
 <li><a class="reference internal" href="#columns-validators-and-converters" id="id4">Columns, validators and converters</a></li>
 </ul>
 </li>
-<li><a class="reference internal" href="#style-guide" id="id5">Style Guide</a></li>
-<li><a class="reference internal" href="#testing" id="id6">Testing</a></li>
-<li><a class="reference internal" href="#documentation" id="id7">Documentation</a></li>
+<li><a class="reference internal" href="#branch-workflow" id="id5">Branch workflow</a></li>
+<li><a class="reference internal" href="#style-guide" id="id6">Style Guide</a></li>
+<li><a class="reference internal" href="#testing" id="id7">Testing</a></li>
+<li><a class="reference internal" href="#documentation" id="id8">Documentation</a></li>
 </ul>
 </li>
 </ul>
@@ -197,6 +199,17 @@ <h3>Columns, validators and converters<a class="headerlink" href="#columns-valid
 themselves, converters are not used.</p>
 </div>
 </div>
+<div class="section" id="branch-workflow">
+<h2>Branch workflow<a class="headerlink" href="#branch-workflow" title="Permalink to this headline">¶</a></h2>
+<p>Initially <code class="docutils literal"><span class="pre">SQLObject</span></code> was being developed using <code class="docutils literal"><span class="pre">Subversion</span></code>. Even
+after switching to git development process somewhat preserves the old
+workflow.</p>
+<p>The <code class="docutils literal"><span class="pre">trunk</span></code>, called <code class="docutils literal"><span class="pre">master</span></code> in git, is the most advanced and the
+most unstable branch. It is where new features are applied. Bug fixes
+are applied to <code class="docutils literal"><span class="pre">oldstable</span></code> and <code class="docutils literal"><span class="pre">stable</span></code> branches and are merged
+upward &#8211; from <code class="docutils literal"><span class="pre">oldstable</span></code> to <code class="docutils literal"><span class="pre">stable</span></code> and from <code class="docutils literal"><span class="pre">stable</span></code> to
+<code class="docutils literal"><span class="pre">master</span></code>.</p>
+</div>
 <div class="section" id="style-guide">
 <h2>Style Guide<a class="headerlink" href="#style-guide" title="Permalink to this headline">¶</a></h2>
 <p>Generally you should follow the recommendations in <a class="reference external" href="http://www.python.org/dev/peps/pep-0008/">PEP 8</a>, the
diff --git a/devel/_sources/DeveloperGuide.rst.txt b/devel/_sources/DeveloperGuide.rst.txt
@@ -104,6 +104,19 @@ converters. Another approach for ``from_python`` is to return an object
 that has ``__sqlrepr__`` method. Such objects convert to SQL strings
 themselves, converters are not used.
 
+Branch workflow
+===============
+
+Initially ``SQLObject`` was being developed using ``Subversion``. Even
+after switching to git development process somewhat preserves the old
+workflow.
+
+The ``trunk``, called ``master`` in git, is the most advanced and the
+most unstable branch. It is where new features are applied. Bug fixes
+are applied to ``oldstable`` and ``stable`` branches and are merged
+upward -- from ``oldstable`` to ``stable`` and from ``stable`` to
+``master``.
+
 Style Guide
 ===========
 
diff --git a/devel/searchindex.js b/devel/searchindex.js
