forrest-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From brond...@apache.org
Subject svn commit: rev 9342 - xml/forrest/trunk/src/documentation/content/xdocs
Date Wed, 10 Mar 2004 16:16:44 GMT
Author: brondsem
Date: Wed Mar 10 08:16:43 2004
New Revision: 9342

Modified:
   xml/forrest/trunk/src/documentation/content/xdocs/build.xml
   xml/forrest/trunk/src/documentation/content/xdocs/compliance.xml
   xml/forrest/trunk/src/documentation/content/xdocs/contrib.xml
   xml/forrest/trunk/src/documentation/content/xdocs/faq.xml
   xml/forrest/trunk/src/documentation/content/xdocs/site.xml
Log:
update docs for SVN

Modified: xml/forrest/trunk/src/documentation/content/xdocs/build.xml
==============================================================================
--- xml/forrest/trunk/src/documentation/content/xdocs/build.xml	(original)
+++ xml/forrest/trunk/src/documentation/content/xdocs/build.xml	Wed Mar 10 08:16:43 2004
@@ -8,52 +8,17 @@
     <section id="getting_from_source">
       <title>Getting the Forrest source</title>
       <section>
-        <title>Step-by-step cvs instructions for Windows</title>
+        <title>Step-by-step Subversion (SVN) instructions</title>
+          <note>If you are behind a proxy, see <link 
+href="http://subversion.tigris.org/project_faq.html#proxy">this FAQ</link>.</note>
         <ol> 
-          <li>Download a recent release of WinCVS (homepage is
-            <link href="http://www.wincvs.org/">http://www.wincvs.org/</link>);
</li> 
-          <li>Install it;</li> 
-          <li>Start it;</li> 
-          <li>Click on Admin-&gt;Preferences;</li> 
-          <li> In "Enter the CVSROOT:" enter
-            "<code>:pserver:anoncvs@cvs.apache.org:/home/cvspublic</code>" (without
-            quotes);</li> 
-          <li>In "Authentication:" choose "passwd file on the cvs server";</li>

-          <li>Click "Ok";</li> 
-          <li>Click Admin-&gt;Login;</li> 
-          <li> When asked for the password: answer "<code>anoncvs</code>"
-            (without quotes);</li> 
-          <li> Click "Create-&gt;Checkout module";</li> 
-          <li>Module name and path on the server is "<code>xml-forrest</code>"
-            (no quotes);</li> 
-          <li>Choose a dir to put the source code in;</li> 
-          <li>Click "Ok";</li> 
-          <li>If everything goes well, messages will start to appear in the log
-            window;</li> 
-          <li>Wait until you see "<code>*****CVS exited normally with code
-              0*****</code>" in the log window;</li> 
-          <li>The Forrest source is now on your harddrive.</li> 
+          <li>Make sure you have a recent release of <link href="http://subversion.tigris.org/">Subversion</link>
installed.</li>
+          <li>At a command prompt, enter "<code>svn co https://svn.apache.org/repos/asf/xml/forrest/trunk
forrest</code>"</li>
+          <li>This will create a directory called "<code>forrest</code>"
where the Forrest source will be stored.</li> 
         </ol> 
-      </section> 
-      <section>
-        <title>Step-by-step cvs instructions for Unix</title>
-        <ol> 
-          <li>Make sure you have a CVS client package installed on your Unix
-            system.</li> 
-          <li>Start the shell of your choice.</li> 
-          <li>Enter "<code>cvs -d
-              :pserver:anoncvs@cvs.apache.org:/home/cvspublic login</code>".</li>

-          <li>When asked for the password: answer "<code>anoncvs</code>".</li>

-          <li>Enter "<code>cvs -d
-              :pserver:anoncvs@cvs.apache.org:/home/cvspublic -z3 checkout
-              xml-forrest</code>". This will create a directory called
-            "<code>xml-forrest</code>" where the Forrest source will be stored.</li>

-          <li>Wait until cvs has finished.</li> 
-          <li>The Forrest source is now on your harddrive.</li> 
-        </ol> 
-        <p>In case you want to update your Forrest source tree to the current
-          version, change to the "<code>xml-forrest</code>" directory and invoke
-          "<code>cvs -z3 update -d -P</code>".</p> 
+        <p>In case you want to update your Forrest source tree to the current version,
change to the 
+"<code>forrest</code>" directory and invoke "<code>svn up</code>".</p>

+        <p>To see what changes you've made, invoke "<code>svn stat</code>"</p>
       </section> 
     </section>
 
@@ -85,7 +50,7 @@
        You now have the binary distribution built in <code>build/dist/shbat</code>.
        Copy it somewhere more sensible if you like (e.g.
        <code>/usr/local/forrest</code> on Unix), though if you intend to update
your
-       Forrest from CVS, leaving it where it is would be best.</p>
+       Forrest from SVN, leaving it where it is would be best.</p>
      <p>
        As the message says, you need to add the distribution's <code>bin/</code>
        ("binary") directory to your PATH variable, so the <code>'forrest'</code>
@@ -96,7 +61,7 @@
 ~/apache/xml-forrest$ export PATH=$PATH:$FORREST_HOME/bin
      </source>
      <p>
-       After updating the Forrest source from CVS, or after you have made changes, you
+       After updating the Forrest source from SVN, or after you have made changes, you
        will need to build forrest again.  In Windows, run <code>build clean</code>
then
        <code>build</code>.  In Unix, run <code>./build.sh clean</code>
then <code>./build.sh</code>
      </p>

Modified: xml/forrest/trunk/src/documentation/content/xdocs/compliance.xml
==============================================================================
--- xml/forrest/trunk/src/documentation/content/xdocs/compliance.xml	(original)
+++ xml/forrest/trunk/src/documentation/content/xdocs/compliance.xml	Wed Mar 10 08:16:43 2004
@@ -14,7 +14,7 @@
       </p>
       <note>
         For your testing, use the Forrestbot generated website, because that
-        reflects the current CVS ...
+        reflects the current SVN code ...
         <link href="http://forrestbot.cocoondev.org/sites/xml-forrest/">http://forrestbot.cocoondev.org/sites/xml-forrest/</link>
       </note>
     </section> 

Modified: xml/forrest/trunk/src/documentation/content/xdocs/contrib.xml
==============================================================================
--- xml/forrest/trunk/src/documentation/content/xdocs/contrib.xml	(original)
+++ xml/forrest/trunk/src/documentation/content/xdocs/contrib.xml	Wed Mar 10 08:16:43 2004
@@ -18,8 +18,8 @@
       information on how to subscribe and to access the mail list archives).
       Listen-in for a while, to hear how others make contributions. </p>
       <p>You can get your local working copy of the
-        <link href="site:CVS">latest and
-      greatest code</link> (which you find in the Forrest module in the CVS code
+        <link href="site:SVN">latest and
+      greatest code</link> (which you find in the Forrest module in the SVN code
       repository. Review the todo list, choose a task (or perhaps you have noticed
       something that needs patching). Make the changes, do the testing, generate a
       patch, and post to the dev mailing list. (Do not worry - the process is easy
@@ -59,35 +59,24 @@
       </ul>
     </section> <anchor id="cvshowto"/>
     <section>
-    <title>CVS Usage Precis</title>
-      <p>An overview of how to use CVS to participate in Forrest development.
+    <title>SVN Usage</title>
+      <p>An overview of how to use SVN to participate in Forrest development.
         Do not be afraid - you cannot accidently destroy the actual code repository,
         because you are working with a local copy as an anonymous user. Therefore, you
         do not have the system permissions to change anything. You can only update your
         local repository and compare your revisions with the real repository. </p>
-      <p> (Further general CVS usage information is at
-        <link href="http://www.cvshome.org/">www.cvshome.org</link> and your
local
-      <code>info cvs</code> pages or <code>man cvs</code> pages or
user
+      <p> (Further general SVN usage information is at
+        <link href="http://subversion.tigris.org/">subversion.tigris.org</link>
and your local
+      <code>info svn</code> pages or <code>man svn</code> pages or
user
       documentation.) </p>
-      <p> Let us lead by example. We will show you how to establish your local
-        repository, how to keep it up-to-date, and how to generate the differences to
-        create a patch. (The commands are for Linux.) </p>
     </section> <anchor id="ssh"/>
     <section>
-    <title>CVS Committer with Secure Shell access</title>
+    <title>SVN Committer with Secure Shell access</title>
       <p>After a developer has consistently provided contributions (code,
         documentation and discussion), then the rest of the dev community may vote to
-        grant this developer commit access to CVS. </p>
+        grant this developer commit access to the Subversion repository. </p>
       <p>You will need secure access to the repository to be able to commit
-        patches. Here are some resources that help to get your machine configured to
-        use the repository over SSH. </p>
-      <ul>
-        <li><link href="http://cvsbook.red-bean.com/">The CVS Book</link></li>
-      <li><link href="http://www.cvshome.org/">www.cvshome.org</link></li>
-      <li><link href="http://jakarta.apache.org/site/cvsindex.html">Jakarta Guide:
CVS Repository</link> -
-      See the bottom of the page for links to tips for UNIX and Windows. Even if you
-      are on UNIX, the Windows page will also help.</li>
-      </ul>
+        patches. The <link href="site:build">building page</link> should have
all the instructions you need to get your machine configured to use the repository. </p>
     </section> <anchor id="procedure"/>
     <section>
     <title>Procedure for Raising Development Issues</title>
@@ -167,10 +156,10 @@
       <li> Do not bother to send an email reply that simply says "thanks". When
         the issue is resolved, that is the finish - end of thread. Reduce clutter.
         </li>
-      <li> You would usually do any development work against the HEAD branch of
-        CVS. </li>
+      <li> You would usually do any development work against the trunk of
+        SVN. </li>
       <li> When sending a patch, you usually do not need to worry about which
-        CVS branch it should be applied to. The maintainers of the repository will
+        SVN branch it should be applied to. The maintainers of the repository will
         decide. </li>
       <li> If an issue starts to get bogged down in list discussion, then it
         may be appropriate to go into private off-list discussion with a few interested

Modified: xml/forrest/trunk/src/documentation/content/xdocs/faq.xml
==============================================================================
--- xml/forrest/trunk/src/documentation/content/xdocs/faq.xml	(original)
+++ xml/forrest/trunk/src/documentation/content/xdocs/faq.xml	Wed Mar 10 08:16:43 2004
@@ -35,24 +35,22 @@
 
     <faq id="cvs">
       <question>
-        I would rather use CVS so that i can keep up-to-date. How?
+        What happened to CVS?
       </question>
       <answer>
         <p>
-          Follow these
-          <link href="site:build">Building Forrest</link> notes.
+          Forrest switched from a CVS code repository to a SVN (subversion) code repository.
 The CVS 
+repository is not kept current.
         </p>
       </answer>
     </faq>
-
-    <faq id="checked_out_now_what">
+    <faq id="svn">
       <question>
-        I have checked out a working copy of <code>xml-forrest</code> CVS, now
what?
+        How can I use SVN to keep up to date with the latest codebase?
       </question>
       <answer>
         <p>
-          Follow these
-          <link href="site:build">Building Forrest</link> notes.
+          Follow these <link href="site:build">Building Forrest</link> notes.
         </p>
         <p>
           The <link href="site:your-project">Using Forrest</link> guide provides

Modified: xml/forrest/trunk/src/documentation/content/xdocs/site.xml
==============================================================================
--- xml/forrest/trunk/src/documentation/content/xdocs/site.xml	(original)
+++ xml/forrest/trunk/src/documentation/content/xdocs/site.xml	Wed Mar 10 08:16:43 2004
@@ -88,7 +88,7 @@
   <getting-involved label="Getting Involved">
     <contrib label="Contributing" href="contrib.html"/>
     <build label="Building Forrest" href="build.html"/>
-    <CVS label="Browse CVS" href="http://cvs.apache.org/viewcvs/xml-forrest/"/>
+    <SVN label="Browse SVN" href="http://svn.apache.org/viewcvs.cgi/xml/forrest/trunk/?root=Apache-SVN"/>
     <mail-lists label="Mail lists" href="mail-lists.html">
       <forrest-dev href="#forrest-dev"/>
     </mail-lists>

Mime
View raw message