Subversionify the documentation.
authorReid Spencer <rspencer@reidspencer.com>
Mon, 9 Jul 2007 08:04:31 +0000 (08:04 +0000)
committerReid Spencer <rspencer@reidspencer.com>
Mon, 9 Jul 2007 08:04:31 +0000 (08:04 +0000)
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@38442 91177308-0d34-0410-b5e6-96231b3b80d8

12 files changed:
docs/CodingStandards.html
docs/DeveloperPolicy.html
docs/FAQ.html
docs/GettingStartedVS.html
docs/HowToReleaseLLVM.html
docs/HowToSubmitABug.html
docs/Makefile
docs/Projects.html
docs/ReleaseNotes.html
docs/Stacker.html
docs/TestingGuide.html
docs/index.html

index dddd84fc5085e25ce63e5c7a73bc2b3363cf5644..f6316194bf6282c15598be5a91907e6fb0d3e3c1 100644 (file)
@@ -122,9 +122,9 @@ documentation is very useful:</p>
 
 <b>File Headers</b>
 
-<p>Every source file should have a header on it that
-describes the basic purpose of the file.  If a file does not have a header, it
-should not be checked into CVS.  Most source trees will probably have a standard
+<p>Every source file should have a header on it that describes the basic 
+purpose of the file.  If a file does not have a header, it should not be 
+checked into Subversion.  Most source trees will probably have a standard
 file header format.  The standard format for the LLVM source tree looks like
 this:</p>
 
index 85b8aab2c1b23099eab5583623cb259c317dcf5e..34e4d9ed154b5318eb159b66a3100857e4235831 100644 (file)
@@ -46,7 +46,7 @@
   <ol>
     <li>Attract both users and developers to the LLVM project.</li>
     <li>Make life as simple and easy for contributors as possible.</li>
-    <li>Keep the top of tree CVS/SVN trees as stable as possible.</li>
+    <li>Keep the top of Subversion trees as stable as possible.</li>
   </ol>
   
   <p>This policy is aimed at frequent contributors to LLVM. People interested in
 <p>When making a patch for review, the goal is to make it as easy for the
    reviewer to read it as possible.  As such, we recommend that you:</p>
   <ol>
-    <li>Make your patch against the CVS HEAD (main development trunk), 
-        not a branch, and not an old version of LLVM.  This makes it easy to
-        apply the patch.</li>
+    <li>Make your patch against the Subversion trunk, not a branch, and not an 
+    old version of LLVM.  This makes it easy to apply the patch.</li>
         
     <li>Similarly, patches should be submitted soon after they are generated.
     Old patches may not apply correctly if the underlying code changes between
     the time the patch was created and the time it is applied.</li>
         
     <li>Patches should be made with this command:
-    <pre>cvs diff -Ntdup -5</pre>
+    <pre>svn diff -x -u</pre>
      or with the utility <tt>utils/mkpatch</tt>, which makes it easy to read the
      diff.</li>
      
   <p>Developers should participate in code reviews as both reviewers and 
     reviewees. If someone is kind enough to review your code, you should
     return the favor for someone else.  Note that anyone is welcome to review
-    and give feedback on a patch, but only people with CVS write access can 
-    approve it.</p>
+    and give feedback on a patch, but only people with Subversion write access 
+    can approve it.</p>
 
 </div>
 
@@ -367,7 +366,7 @@ Changes</a></div>
     changes.  Despite this, once set, the attribution of a file never changes.
     Revision control keeps an accurate history of contributions.</li>
     <li>Developers should maintain their entry in the 
-    <a href="http://llvm.org/cvsweb/cvsweb.cgi/llvm/CREDITS.TXT?rev=HEAD&amp;content-type=text/x-cvsweb-markup">CREDITS.txt</a> 
+    <a href="http://llvm.org/svn/llvm-project/llvm/trunk/CREDITS.TXT">CREDITS.txt</a> 
     file to summarize their contributions.</li>
     <li>Commit comments should contain correct attribution of the person who
     submitted the patch if that person is not the committer (i.e. when a 
index 7342488193ad6d97f8ec99dec7483165a7f11642..96360d06a1ca42b60bbfe4ed0e8db00cc264904f 100644 (file)
@@ -39,8 +39,8 @@
   <li>The <tt>configure</tt> script finds the right C compiler, but it uses the
   LLVM linker from a previous build.  What do I do?</li>
   <li>When creating a dynamic library, I get a strange GLIBC error.</li>
-  <li>I've updated my source tree from CVS, and now my build is trying to use a
-  file/directory that doesn't exist.</li>
+  <li>I've updated my source tree from Subversion, and now my build is trying 
+  to use a file/directory that doesn't exist.</li>
   <li>I've modified a Makefile in my source tree, but my build tree keeps using
   the old version.  What do I do?</li>
   <li>I've upgraded to a new version of LLVM, and I get strange build
@@ -50,7 +50,7 @@
   <li>Compiling LLVM with GCC 3.3.2 fails, what should I do?</li>
   <li>When I use the test suite, all of the C Backend tests fail.  What is
       wrong?</li>
-  <li>After CVS update, rebuilding gives the error "No rule to make
+  <li>After Subversion update, rebuilding gives the error "No rule to make
       target".</li>
   <li><a href="#llvmc">The <tt>llvmc</tt> program gives me errors/doesn't
       work.</li></a>
@@ -257,8 +257,8 @@ your own version of GCC that has shared libraries enabled by default.</p>
 </div>
 
 <div class="question">
-<p>I've updated my source tree from CVS, and now my build is trying to use a
-file/directory that doesn't exist.</p>
+  <p>I've updated my source tree from Subversion, and now my build is trying to 
+  use a file/directory that doesn't exist.</p>
 </div>
 
 <div class="answer">
@@ -358,7 +358,8 @@ build.</p>
 </div>
 
 <div class="question">
-<p>After CVS update, rebuilding gives the error "No rule to make target".</p>
+  <p>After Subversion update, rebuilding gives the error 
+  "No rule to make target".</p>
 </div>
 
 <div class="answer">
@@ -372,9 +373,9 @@ Stop.
 </pre>
 </div>
 
-<p>This may occur anytime files are moved within the CVS repository or removed
-entirely.  In this case, the best solution is to erase all <tt>.d</tt> files,
-which list dependencies for source files, and rebuild:</p>
+<p>This may occur anytime files are moved within the Subversion repository or 
+removed entirely.  In this case, the best solution is to erase all 
+<tt>.d</tt> files, which list dependencies for source files, and rebuild:</p>
 
 <div class="doc_code">
 <pre>
@@ -409,11 +410,9 @@ rebuilding.</p>
   available through a special version of GCC that LLVM calls the 
   <a href="#cfe">C Front End</a></p>
   <p>There is an incomplete version of a Java front end available in the
-  <tt>llvm-java</tt> CVS repository. There is no documentation on this yet so
+  <tt>java</tt> module. There is no documentation on this yet so
   you'll need to download the code, compile it, and try it.</p>
-  <p>In the <tt>examples/BFtoLLVM</tt> directory is a translator for the 
-  BrainF*** language (2002 Language Specification).</p>
-  <p>In the <tt>projects/Stacker</tt> directory is a compiler and runtime
+  <p>In the <tt>stacker</tt> module is a compiler and runtime
   library for the Stacker language, a "toy" language loosely based on Forth.</p>
   <p>The PyPy developers are working on integrating LLVM into the PyPy backend
   so that PyPy language can translate to LLVM.</p>
index 90a30bb040e2bd512fe4a3715c5e927c15499d48..05803780a84ceb03a16c8ecb51858ab5df73fdd2 100644 (file)
       <li><tt>cd llvm</tt></li>
     </ol></li>
 
-    <li>With anonymous CVS access:
+    <li>With anonymous Subversion access:
     <ol>
       <li><tt>cd <i>where-you-want-llvm-to-live</i></tt></li>
-      <li><tt>cvs -d
-          :pserver:anon@llvm-cvs.cs.uiuc.edu:/var/cvs/llvm login</tt></li>
-      <li>Hit the return key when prompted for the password.
-      <li><tt>cvs -z3 -d :pserver:anon@llvm-cvs.cs.uiuc.edu:/var/cvs/llvm 
-          co llvm</tt></li>
+      <li><tt>svn co http://llvm.org/svn/llvm-project/llvm-top/trunk llvm-top
+      </tt></li>
+      <li><tt>make checkout MODULE=llvm</tt>
       <li><tt>cd llvm</tt></li>
-      <li><tt>cvs up -P -d</tt></li>
     </ol></li>
   </ul></li>
 
 
 </ol>
 
-<p>It is strongly encouraged that you get the latest version from CVS.  Much
-progress has been made since the 1.4 release.</p>
+<p>It is strongly encouraged that you get the latest version from Subversion as
+changes are continually making the VS support better.</p>
 
 </div>
 
index bee43493c4396f652f4110c78b9cec960018100d..b8461f79a8e6b20aabfdf7a6fef74d27b192f80e 100644 (file)
@@ -139,8 +139,7 @@ fix <em>for the release</em>.
     The Release Manager tags his/her llvm, llvm-test, and llvm-gcc working
     directories with
     "ROOT_RELEASE_XX" where XX is the major and minor
-    release numbers (you can't have . in a cvs tag name). So, for Release 1.2,
-    XX=12 and for Release 1.10, XX=110.
+    release numbers. So, for Release 1.2, XX=12 and for Release 1.10, XX=110.
          
     <p>
     <tt>cvs tag ROOT_RELEASE_XX</tt><br>
@@ -180,8 +179,8 @@ fix <em>for the release</em>.
 <div class="doc_text">
   <p>
   After creating the llvm release branch, update the release branch's autoconf/configure.ac 
-  version from X.Xcvs to just X.X. Update it on mainline as well to be the next version 
-  (X.X+1cvs). 
+  version from X.Xsvn to just X.X. Update it on mainline as well to be the next version 
+  (X.X+1svn). 
   </p>
 
 </div>
@@ -316,8 +315,9 @@ fix <em>for the release</em>.
 <div class="doc_subsection"><a name="webupdates">Update the LLVM Website</a></div>
 <div class="doc_text">
   <p>
-  Check out the llvm-www module from cvs. Create a new subdirectory X.X in the 
-  releases directory. Place the llvm, llvm-test, llvm-gcc source, and llvm-gcc 
+  Check out the <tt>website</tt> module from Subversion. Create a new 
+  subdirectory X.X in the releases directory. Place the llvm, llvm-test, 
+  llvm-gcc source, and llvm-gcc 
   binaries in this new directory. Copy the llvm/docs and LICENSE.txt files 
   into this new directory. Update the releases/download.html file with  the new release. 
   Update the releases/index.html with the new release. Finally, update the main page (
index dca518426e408854e4b0af11247e45cf5eade863..93e0d2107f0d33a4a4997b5a5194b9bfb96b1311 100644 (file)
@@ -67,7 +67,7 @@ information:</p>
 <ul>
   <li>All information necessary to reproduce the problem.</li>
   <li>The reduced test-case that triggers the bug.</li>
-  <li>The location where you obtained LLVM (if not from our CVS
+  <li>The location where you obtained LLVM (if not from our Subversion
   repository).</li>
 </ul>
 
index 9249fbe97f09d4828431d280ddf0fcb521464ccb..58175bd73286440e60364a40a02b7752b2672ed3 100644 (file)
@@ -14,7 +14,7 @@ ifdef BUILD_FOR_WEBSITE
 PROJ_OBJ_DIR = .
 DOXYGEN = doxygen
 # Extract version number from the AC_INT line in configure.ac
-# AC_INIT([[llvm]],[[2.1cvs]],[llvmbugs@cs.uiuc.edu])
+# AC_INIT([[llvm]],[[2.1svn]],[llvmbugs@cs.uiuc.edu])
 PACKAGE_VERSION = $(shell grep AC_INIT ../autoconf/configure.ac | sed -e 's/^[^0-9]*\([0-9_.a-zA-Z-]*\).*/\1/' )
 
 $(PROJ_OBJ_DIR)/doxygen.cfg: doxygen.cfg.in
index ed13b4c83c5bc7c2835b7d12709d5f7f063f99d4..cb7a7c1bcfaa72df570532d54f6321760f9f9378 100644 (file)
@@ -88,10 +88,10 @@ choosing.  You can place it anywhere you like.  Rename the directory to match
 the name of your project.</li>
 
 <li>
-If you downloaded LLVM using CVS, remove all the directories named CVS (and all
-the files therein) from your project's new source tree.  This will keep CVS
-from thinking that your project is inside <tt>llvm/projects/sample</tt>.
-</li>
+If you downloaded LLVM using Subversion, remove all the directories named .svn 
+(and all the files therein) from your project's new source tree.  This will 
+keep Subversion from thinking that your project is inside 
+<tt>llvm/trunk/projects/sample</tt>.</li>
 
 <li>Add your source code and Makefiles to your source tree.</li>
 
index c3449e51e96b40655a0ded2c02a8a3de5c006074..03d2db112fad6312dfa84e06cd9e004d762e7ae2 100644 (file)
@@ -43,7 +43,8 @@ web site</a>.  If you have questions or comments, the <a
 href="http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVM developer's mailing
 list</a> is a good place to send them.</p>
 
-<p>Note that if you are reading this file from CVS or the main LLVM web page,
+<p>Note that if you are reading this file from a Subversion checkout or the 
+main LLVM web page,
 this document applies to the <i>next</i> release, not the current one.  To see
 the release notes for the current or previous releases, see the <a
 href="http://llvm.org/releases/">releases page</a>.</p>
@@ -832,8 +833,8 @@ Exception Handling</a>, and it is not enabled by default.</li>
 <p>A wide variety of additional information is available on the <a
 href="http://llvm.org">LLVM web page</a>, in particular in the <a
 href="http://llvm.org/docs/">documentation</a> section.  The web page also
-contains versions of the API documentation which is up-to-date with the CVS
-version of the source code.
+contains versions of the API documentation which is up-to-date with the
+Subversion version of the source code.
 You can access versions of these documents specific to this release by going
 into the "<tt>llvm/doc/</tt>" directory in the LLVM tree.</p>
 
index 225a27bbf77556707220239e905f8a3d89dff404..102571a1072ef7b819c0b03bfb2ea77a7d356f27 100644 (file)
@@ -1303,8 +1303,9 @@ the <tt>projects</tt> directory so that it will auto-configure. To do that, make
 sure you have the llvm sources in <tt><i>llvm</i></tt> 
 (see <a href="GettingStarted.html">Getting Started</a>) and then use these 
 commands:<pre>
-    cd <i>llvm</i>/projects
-    cvs co llvm-stacker</pre>
+    svn co http://llvm.org/svn/llvm-project/llvm-top/trunk llvm-top
+    cd llvm-top
+    make build MODULE=stacker
 </p>
 <p>Under the <tt>projects/llvm-stacker</tt> directory you will find the
 implementation of the Stacker compiler, as follows:</p>
index 222ccfb52a9b722e3885a67857f4220249a2bc94..cb880373de326ebea7566a4c56375f9d01e98a25 100644 (file)
@@ -106,14 +106,14 @@ and tcl.</p>
 
 <div class="doc_text">
 
-<p>The tests are located in two separate CVS modules. The basic feature and 
-regression tests are in the main "llvm" module under the directory 
-<tt>llvm/test</tt>. A more comprehensive test suite that includes whole 
-programs in C and C++ is in the <tt>llvm-test</tt> module. This module should 
-be checked out to the <tt>llvm/projects</tt> directory. When you
-<tt>configure</tt> the <tt>llvm</tt> module, the <tt>llvm-test</tt> module
-will be automatically configured. Alternatively, you can configure the
- <tt>llvm-test</tt> module manually.</p>
+  <p>The tests are located in two separate Subversion modules. The basic feature
+  and regression tests are in the main "llvm" module under the directory 
+  <tt>llvm/test</tt>. A more comprehensive test suite that includes whole 
+programs in C and C++ is in the <tt>test-suite</tt> module. This module should 
+be checked out to the <tt>llvm/projects</tt> directory as llvm-test (for
+historical purpose).  When you <tt>configure</tt> the <tt>llvm</tt> module, 
+the <tt>llvm-test</tt> directory will be automatically configured. 
+Alternatively, you can configure the <tt>test-suite</tt> module manually.</p>
 <p>To run all of the simple tests in LLVM using DejaGNU, use the master Makefile
  in the <tt>llvm/test</tt> directory:</p>
 <pre>
@@ -140,7 +140,7 @@ programs), run the <tt>llvm-test</tt> tests:</p>
 
 <pre>
 % cd llvm/projects
-% cvs co llvm-test
+% svn co http://llvm.org/svn/llvm-project/test-suite/trunk llvm-test
 % cd llvm-test
 % ./configure --with-llvmsrc=$LLVM_SRC_ROOT --with-llvmobj=$LLVM_OBJ_ROOT
 % gmake
@@ -201,7 +201,7 @@ a way of benchmarking LLVM performance, both in terms of the efficiency of the
 programs generated as well as the speed with which LLVM compiles, optimizes, and
 generates code.</p>
 
-<p>All "whole program" tests are located in the <tt>llvm-test</tt> CVS
+<p>All "whole program" tests are located in the <tt>test-suite</tt> Subversion
 module.</p> 
 
 </div>
@@ -238,8 +238,8 @@ subtrees of the test suite directory tree are as follows:</p>
   piece of LLVM assembly language code, often distilled from an actual 
   application or benchmark.</p></li>
 
-<li><tt>llvm-test</tt>
-<p>The <tt>llvm-test</tt> CVS module contains programs that can be compiled 
+<li><tt>test-suite</tt>
+<p>The <tt>test-suite</tt> module contains programs that can be compiled 
 with LLVM and executed.  These programs are compiled using the native compiler
 and various LLVM backends.  The output from the program compiled with the 
 native compiler is assumed correct; the results from the other programs are
@@ -617,8 +617,8 @@ directory to run them.</p>
 </p>
 <ol>
   <li>cd into the llvm/projects directory</li>
-  <li>check out the <tt>llvm-test</tt> module with:<br/>
-  <tt>cvs -d :pserver:anon@llvm.org:/var/cvs/llvm co -PR llvm-test</tt><br> 
+  <li>check out the <tt>test-suite</tt> module with:<br/>
+  <tt>svn co http://llvm.org/svn/llvm-project/test-suite/trunk llvm-test<br/>
   This will get the test suite into <tt>llvm/projects/llvm-test</tt></li>
   <li>configure the test suite. You can do this one of two ways:
   <ol>
@@ -760,24 +760,15 @@ as keep track of LLVM's progress over time.</p>
 machine, take a look at the comments at the top of the 
 <tt>utils/NewNightlyTest.pl</tt> file. If you decide to set up a nightly tester 
 please choose a unique nickname and invoke <tt>utils/NewNightlyTest.pl</tt> 
-with the "-nickname [yournickname]" command line option. We usually run it 
-from a crontab entry that looks like this:</p>
+with the "-nickname [yournickname]" command line option. 
 
-<div class="doc_code">
-<pre>
-5 3 * * *  $HOME/llvm/utils/NewNightlyTest.pl -parallel -nickname Nickname \
-           $CVSROOT $HOME/buildtest $HOME/cvs/testresults
-</pre>
-</div>
-
-<p>Or, you can create a shell script to encapsulate the running of the script.
+<p>You can create a shell script to encapsulate the running of the script.
 The optimized x86 Linux nightly test is run from just such a script:</p>
 
 <div class="doc_code">
 <pre>
 #!/bin/bash
 BASE=/proj/work/llvm/nightlytest
-export CVSROOT=:pserver:anon@llvm.org:/var/cvs/llvm
 export BUILDDIR=$BASE/build 
 export WEBDIR=$BASE/testresults 
 export LLVMGCCDIR=/proj/work/llvm/cfrontend/install
@@ -786,7 +777,7 @@ export LD_LIBRARY_PATH=/proj/install/lib
 cd $BASE
 cp /proj/work/llvm/llvm/utils/NewNightlyTest.pl .
 nice ./NewNightlyTest.pl -nice -release -verbose -parallel -enable-linscan \
-   -nickname NightlyTester -noexternals 2&gt;&amp;1 &gt; output.log
+   -nickname NightlyTester -noexternals &gt; output.log 2&gt;&amp;1 
 </pre>
 </div>
 
index 75451ad0c185b20257fd8025b9295abd6a51f74d..e3da6ac9b55ed14877d52821a7759e78e0825d75 100644 (file)
@@ -161,8 +161,7 @@ href="http://llvm.org/doxygen/inherits.html">classes</a>)
 (<a href="http://llvm.org/doxygen/doxygen.tar.gz">tarball</a>)
 </li>
 
-<li><a href="http://llvm.org/cvsweb/cvsweb.cgi/llvm">CVSWeb CVS Tree 
-Browser</a></li>
+<li><a href="http://llvm.org/viewvc/">ViewVC Repository Browser</a></li>
 
 </ul>
 
@@ -246,9 +245,9 @@ Patches Archive</a>: This list gets emailed every time a bug is opened and
 closed, and when people submit patches to be included in LLVM.  It is higher 
 volume than the LLVMdev list.</li>
 
-<li>The <a href="http://mail.cs.uiuc.edu/pipermail/llvm-commits/">CVS Commits
+<li>The <a href="http://mail.cs.uiuc.edu/pipermail/llvm-commits/">Commits
 Archive</a>: This list contains all commit messages that are made when LLVM 
-developers commit code changes to the CVS archive. It is useful for those who 
+developers commit code changes to the repository. It is useful for those who 
 want to stay on the bleeding edge of LLVM development. This list is very high
 volume.</li>