Author: crossley Date: Sat Dec 11 17:30:52 2004 New Revision: 111625 URL: http://svn.apache.org/viewcvs?view=rev&rev=111625 Log: Clarify that the instructions are for "release branch" and not "trunk".
Modified: cocoon/site/src/documentation/content/xdocs/community/contrib.xml Modified: cocoon/site/src/documentation/content/xdocs/community/contrib.xml Url: http://svn.apache.org/viewcvs/cocoon/site/src/documentation/content/xdocs/community/contrib.xml?view=diff&rev=111625&p1=cocoon/site/src/documentation/content/xdocs/community/contrib.xml&r1=111624&p2=cocoon/site/src/documentation/content/xdocs/community/contrib.xml&r2=111625 ============================================================================== --- cocoon/site/src/documentation/content/xdocs/community/contrib.xml (original) +++ cocoon/site/src/documentation/content/xdocs/community/contrib.xml Sat Dec 11 17:30:52 2004 @@ -35,9 +35,8 @@ </p> <p>You can get your local working copy of the - <link href="http://svn.apache.org/viewcvs.cgi/cocoon/branches/BRANCH_2_1_X";>latest - and greatest code</link> (which you find in the cocoon-2.1 module in - the svn.apache.org CVS code repository). + <link href="http://svn.apache.org/viewcvs.cgi/cocoon/branches/BRANCH_2_1_X";>release branch</link> (which you find in the cocoon-2.1 module in + the svn.apache.org code repository). Review the <link href="http://cocoon.apache.org/2.1/todo.html";>todo</link> list, choose a task (or perhaps you have noticed something that needs patching). Make the changes, do the testing, generate a patch, if you need then discuss it on @@ -188,8 +187,8 @@ <p> (Further general Subversion usage information is at <link href="http://subversion.tigris.org/";>subversion.tigris.org</link>. Other resources include - <link href="http://softech.informatik.uni-kl.de/softech/content/einfothek/e2348/e2328/index_ger.html";>a fast introduction</link> - and <link href="http://svnbook.red-bean.com/";>"Version Control with Subversion"</link>. + <link href="http://svnbook.red-bean.com/";>"Version Control with Subversion"</link> and + <link href="http://softech.informatik.uni-kl.de/softech/content/einfothek/e2348/e2328/index_ger.html";>a fast introduction</link>. </p> <p> @@ -201,19 +200,25 @@ <s2 title="How to Establish your Local Repository"> <p> - This will checkout the current copy of the master repository and + Decide whether you want to work with the "release branch" (2.1.X) or with + the trunk (2.2). Some developers use both. + </p> + + <p> + The following procedure will checkout the current copy of the release branch + of the master repository and download it to your local disk. It will create a sub-directory called - <code>BRANCH-2.1.X</code> + <code>BRANCH_2_1_X</code> </p> <ol> <li><code>cd /usr/local/svn/cocoon</code></li> <li><code>svn co http://svn.apache.org/repos/asf/cocoon/branches/BRANCH_2_1_X/</code></li> - <li><code>cd BRANCH-2.1.X</code></li> + <li><code>cd BRANCH_2_1_X</code></li> </ol> <p> - You now have the HEAD branch of the current development repository + You now have the release branch of the current source repository for Cocoon on your local system. Go ahead and build and deploy as usual. Make some changes, re-build, and see the effect. </p> @@ -233,7 +238,7 @@ </p> <ol> - <li><code>cd /usr/local/svn/cocoon/BRANCH-2.1.X</code></li> + <li><code>cd /usr/local/svn/cocoon/BRANCH_2_1_X</code></li> <li><code>svn update</code></li> <li><strong>... pay attention to the update messages</strong></li> </ol> @@ -259,16 +264,16 @@ <ol> <li>Make the desired changes in your local repository, build, test it thoroughly</li> - <li><code>cd /usr/local/svn/cocoon/BRANCH-2.1.X/xdocs</code></li> + <li><code>cd /usr/local/svn/cocoon/BRANCH_2_1_X/xdocs</code></li> <li><code>svn diff contrib.xml > $WORK/cocoon/contrib.xml.diff</code></li> </ol> </s2> <s2 title="How to get other branches"> - <p>OK that got the current branch of Cocoon into your local working copy. + <p>Okay, that got the current release branch of Cocoon into your local working copy. If you want some other branch, then find the relevant branch name from ViewCVS - <link href="http://svn.apache.org/viewcvs.cgi/cocoon/";>http://svn.apache.org/viewcvs.cgi/cocoon/</link> (see the Tags list at the bottom). + <link href="http://svn.apache.org/viewcvs.cgi/cocoon/";>http://svn.apache.org/viewcvs.cgi/cocoon/</link> Then follow the same checkout procedure described above, using this ... </p> @@ -276,6 +281,16 @@ <li><code>cd /usr/local/svn/cocoon</code></li> <li><code>svn co http://svn.apache.org/repos/asf/cocoon/branches/<i>branchname</i></code></li> </ul> + + <p> + If you want to work with the trunk, then do this to create a local directory + called "cocoon-trunk" ... + </p> + + <ul> + <li><code>cd /usr/local/svn/cocoon</code></li> + <li><code>svn co http://svn.apache.org/repos/asf/cocoon/trunk cocoon-trunk</code></li> + </ul> </s2> </s1> @@ -447,13 +462,10 @@ Reduce clutter. </li> <li> - You would usually do any development work against the BRANCH-2.1.X branch of the - subversion repository. - </li> - <li> - When sending a patch, you usually do not need to worry about which CVS + When sending a patch, you usually do not need to worry about which branch it should be applied to. The maintainers of the repository will - decide. + decide and might also apply it to the trunk. Please indicate on the + Bugzilla entry which branch you have used to prepare your patch. </li> <li> If an issue starts to get bogged down in list discussion, then it may
