User: pathoss
Date: 02/09/17 15:32:31
Modified: xdocs/development branches.xml
Log:
Updated.
Revision Changes Path
1.2 +96 -50 xdoclet/xdocs/development/branches.xml
Index: branches.xml
===================================================================
RCS file: /cvsroot/xdoclet/xdoclet/xdocs/development/branches.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -w -r1.1 -r1.2
--- branches.xml 17 Sep 2002 22:13:51 -0000 1.1
+++ branches.xml 17 Sep 2002 22:32:31 -0000 1.2
@@ -7,6 +7,31 @@
<body>
<section name="Branches and Tags">
+ <p>
+ The branches are a feature of CVS that allows the development to be
partitioned
+ so that one stream does not affect the other. They prove to be
useful, when
+ there is a need to perform modifications that are hard to perform
as a
+ consecutive gradual transitions that work well in the usual course
of
+ development. When files that are depended upon by numerous other
files need to
+ be substantially changed all the other would have to be modified
along with
+ them. That would require that a lone developer performs all these
changes in his
+ own snapshot and then checks them all in, causing the sources to
leap forward.
+ As your project grows, situations arise that this is no longer
possible. It's good to
+ have version control on the gradual changes as opposed to
quantum-leap changes.
+ It's also important to have the larges set of eyes possible looking
at the code
+ as soon as possible. On the other hand, we strive to keep XDoclet
CVS tree
+ compilable and working at all times. This calls for usage of
branches whenever
+ vast modifications of the sources are needed.
+ </p>
+
+ <p>
+ The <a href="http://www.red-bean.com/cvsbook/";>CVS book</a>
describes multiple
+ approaches to performing development using branches. The simplest
approach
+ called <em>Flying Fish technique</em> will fit our needs best.
+ It involves creating a branch when there is a need for a separate
thread of
+ development, and abandoning the branch once all the changes are
merged with the
+ trunk.
+ </p>
<subsection name="Branches">
<p>
XDoclet CVS has following branches:
@@ -49,6 +74,27 @@
Currently XDoclet CVS has no tags.
</p>
</subsection>
+ <subsection name="Naming Conventions">
+ <p>
+ The naming scheme used for the branches is as following:
xdoclet, followed by
+ an underscore, a name describing the subject being worked on,
and optionally
+ followed by an underscore and a two digit number (seperated
with underscore)
+ for marking the revision of the trunk where the branch diverged.
+ </p>
+
+ <p>
+ Actual tag names are then:
+ <ul>
+
<li><em>xdoclet</em>_<em>subject</em>_<em>number</em>-sprout for marking the
+ revision of the trunk where the branch diverged</li>
+
<li><em>xdoclet</em>_<em>subject</em>_<em>number</em>-branch for the branch itself</li>
+
<li><em>xdoclet</em>_<em>subject</em>_<em>number</em>-before-merge for marking the last
+ revision of files before merging in the branch</li>
+ <li><em>xdoclet</em>_<em>subject</em>_<em>number</em>-merge
for marking the revision of the trunk
+ with changes made on the branch merged in</li>
+ </ul>
+ </p>
+ </subsection>
</section>
</body>
</document>
-------------------------------------------------------
This SF.NET email is sponsored by: AMD - Your access to the experts
on Hammer Technology! Open Source & Linux Developers, register now
for the AMD Developer Symposium. Code: EX8664
http://www.developwithamd.com/developerlab
_______________________________________________
Xdoclet-devel mailing list
[EMAIL PROTECTED]
https://lists.sourceforge.net/lists/listinfo/xdoclet-devel
