From 669ed45029765df223ba7e9cdc242f62c17497e4 Mon Sep 17 00:00:00 2001 From: Reid Spencer Date: Mon, 9 Jul 2007 08:04:31 +0000 Subject: [PATCH] Subversionify the documentation. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@38442 91177308-0d34-0410-b5e6-96231b3b80d8 --- docs/CodingStandards.html | 6 +++--- docs/DeveloperPolicy.html | 15 +++++++------ docs/FAQ.html | 25 +++++++++++----------- docs/GettingStartedVS.html | 15 ++++++------- docs/HowToReleaseLLVM.html | 12 +++++------ docs/HowToSubmitABug.html | 2 +- docs/Makefile | 2 +- docs/Projects.html | 8 +++---- docs/ReleaseNotes.html | 7 ++++--- docs/Stacker.html | 5 +++-- docs/TestingGuide.html | 43 +++++++++++++++----------------------- docs/index.html | 7 +++---- 12 files changed, 67 insertions(+), 80 deletions(-) diff --git a/docs/CodingStandards.html b/docs/CodingStandards.html index dddd84fc508..f6316194bf6 100644 --- a/docs/CodingStandards.html +++ b/docs/CodingStandards.html @@ -122,9 +122,9 @@ documentation is very useful:

File Headers -

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 +

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:

diff --git a/docs/DeveloperPolicy.html b/docs/DeveloperPolicy.html index 85b8aab2c1b..34e4d9ed154 100644 --- a/docs/DeveloperPolicy.html +++ b/docs/DeveloperPolicy.html @@ -46,7 +46,7 @@
  1. Attract both users and developers to the LLVM project.
  2. Make life as simple and easy for contributors as possible.
    3. -
  3. Keep the top of tree CVS/SVN trees as stable as possible.
    4. +
  4. Keep the top of Subversion trees as stable as possible.

This policy is aimed at frequent contributors to LLVM. People interested in @@ -93,16 +93,15 @@

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:

    -
  1. 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.
    2. +
  2. 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.
  3. 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.
  4. Patches should be made with this command: - 
    cvs diff -Ntdup -5
    + 
    svn diff -x -u
    or with the utility utils/mkpatch, which makes it easy to read the diff.
    5. @@ -141,8 +140,8 @@

    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.

    + and give feedback on a patch, but only people with Subversion write access + can approve it.

    @@ -367,7 +366,7 @@ Changes changes. Despite this, once set, the attribution of a file never changes. Revision control keeps an accurate history of contributions.
  5. Developers should maintain their entry in the - CREDITS.txt + CREDITS.txt file to summarize their contributions.
  6. Commit comments should contain correct attribution of the person who submitted the patch if that person is not the committer (i.e. when a diff --git a/docs/FAQ.html b/docs/FAQ.html index 7342488193a..96360d06a1c 100644 --- a/docs/FAQ.html +++ b/docs/FAQ.html @@ -39,8 +39,8 @@
  7. The configure script finds the right C compiler, but it uses the LLVM linker from a previous build. What do I do?
  8. When creating a dynamic library, I get a strange GLIBC error.
    9. -
  9. I've updated my source tree from CVS, and now my build is trying to use a - file/directory that doesn't exist.
    10. +
  10. I've updated my source tree from Subversion, and now my build is trying + to use a file/directory that doesn't exist.
  11. I've modified a Makefile in my source tree, but my build tree keeps using the old version. What do I do?
  12. I've upgraded to a new version of LLVM, and I get strange build @@ -50,7 +50,7 @@
  13. Compiling LLVM with GCC 3.3.2 fails, what should I do?
  14. When I use the test suite, all of the C Backend tests fail. What is wrong?
    15. -
  15. After CVS update, rebuilding gives the error "No rule to make +
  16. After Subversion update, rebuilding gives the error "No rule to make target".
  17. The llvmc program gives me errors/doesn't work.
    18. @@ -257,8 +257,8 @@ your own version of GCC that has shared libraries enabled by default.

    -

    I've updated my source tree from CVS, and now my build is trying to use a -file/directory that doesn't exist.

    +

    I've updated my source tree from Subversion, and now my build is trying to + use a file/directory that doesn't exist.

    @@ -358,7 +358,8 @@ build.

    -

    After CVS update, rebuilding gives the error "No rule to make target".

    +

    After Subversion update, rebuilding gives the error + "No rule to make target".

    @@ -372,9 +373,9 @@ Stop.
    -

    This may occur anytime files are moved within the CVS repository or removed -entirely. In this case, the best solution is to erase all .d files, -which list dependencies for source files, and rebuild:

    +

    This may occur anytime files are moved within the Subversion repository or +removed entirely. In this case, the best solution is to erase all +.d files, which list dependencies for source files, and rebuild:

    @@ -409,11 +410,9 @@ rebuilding.
    
   available through a special version of GCC that LLVM calls the 
   C Front End
    
   
    There is an incomplete version of a Java front end available in the
-  llvm-java CVS repository. There is no documentation on this yet so
+  java module. There is no documentation on this yet so
   you'll need to download the code, compile it, and try it.
    
-  
    In the examples/BFtoLLVM directory is a translator for the 
-  BrainF*** language (2002 Language Specification).
    
-  
    In the projects/Stacker directory is a compiler and runtime
+  
    In the stacker module is a compiler and runtime
   library for the Stacker language, a "toy" language loosely based on Forth.
    
   
    The PyPy developers are working on integrating LLVM into the PyPy backend
   so that PyPy language can translate to LLVM.
    
diff --git a/docs/GettingStartedVS.html b/docs/GettingStartedVS.html
index 90a30bb040e..05803780a84 100644
--- a/docs/GettingStartedVS.html
+++ b/docs/GettingStartedVS.html
@@ -99,16 +99,13 @@
       
  18. cd llvm
    19.
-
  • With anonymous CVS access: +
  • With anonymous Subversion access:
    1. cd where-you-want-llvm-to-live
      2. -
    2. cvs -d - :pserver:anon@llvm-cvs.cs.uiuc.edu:/var/cvs/llvm login
      3. -
    3. Hit the return key when prompted for the password. -
    4. cvs -z3 -d :pserver:anon@llvm-cvs.cs.uiuc.edu:/var/cvs/llvm - co llvm
      5. +
    5. svn co http://llvm.org/svn/llvm-project/llvm-top/trunk llvm-top +
      6. +
    6. make checkout MODULE=llvm
    7. cd llvm
      8. -
    8. cvs up -P -d
    • @@ -128,8 +125,8 @@ -

    It is strongly encouraged that you get the latest version from CVS. Much -progress has been made since the 1.4 release.

    +

    It is strongly encouraged that you get the latest version from Subversion as +changes are continually making the VS support better.

    diff --git a/docs/HowToReleaseLLVM.html b/docs/HowToReleaseLLVM.html index bee43493c43..b8461f79a8e 100644 --- a/docs/HowToReleaseLLVM.html +++ b/docs/HowToReleaseLLVM.html @@ -139,8 +139,7 @@ fix for the release. 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.

    cvs tag ROOT_RELEASE_XX
    @@ -180,8 +179,8 @@ fix for the release.

    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).

    @@ -316,8 +315,9 @@ fix for the release.
    Update the LLVM Website

    - 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 website 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 ( diff --git a/docs/HowToSubmitABug.html b/docs/HowToSubmitABug.html index dca518426e4..93e0d2107f0 100644 --- a/docs/HowToSubmitABug.html +++ b/docs/HowToSubmitABug.html @@ -67,7 +67,7 @@ information:

    diff --git a/docs/Makefile b/docs/Makefile index 9249fbe97f0..58175bd7328 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -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 diff --git a/docs/Projects.html b/docs/Projects.html index ed13b4c83c5..cb7a7c1bcfa 100644 --- a/docs/Projects.html +++ b/docs/Projects.html @@ -88,10 +88,10 @@ choosing. You can place it anywhere you like. Rename the directory to match the name of your project.
  • -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 llvm/projects/sample. -
    • +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 +llvm/trunk/projects/sample.
  • Add your source code and Makefiles to your source tree.
    • diff --git a/docs/ReleaseNotes.html b/docs/ReleaseNotes.html index c3449e51e96..03d2db112fa 100644 --- a/docs/ReleaseNotes.html +++ b/docs/ReleaseNotes.html @@ -43,7 +43,8 @@ web site. If you have questions or comments, the LLVM developer's mailing list is a good place to send them.

    -

    Note that if you are reading this file from CVS or the main LLVM web page, +

    Note that if you are reading this file from a Subversion checkout or the +main LLVM web page, this document applies to the next release, not the current one. To see the release notes for the current or previous releases, see the releases page.

    @@ -832,8 +833,8 @@ Exception Handling, and it is not enabled by default.

    A wide variety of additional information is available on the LLVM web page, in particular in the documentation 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 "llvm/doc/" directory in the LLVM tree.

    diff --git a/docs/Stacker.html b/docs/Stacker.html index 225a27bbf77..102571a1072 100644 --- a/docs/Stacker.html +++ b/docs/Stacker.html @@ -1303,8 +1303,9 @@ the projects directory so that it will auto-configure. To do that, make sure you have the llvm sources in llvm (see Getting Started) and then use these commands:
    -    cd llvm/projects
-    cvs co llvm-stacker
    + svn co http://llvm.org/svn/llvm-project/llvm-top/trunk llvm-top + cd llvm-top + make build MODULE=stacker

    Under the projects/llvm-stacker directory you will find the implementation of the Stacker compiler, as follows:

    diff --git a/docs/TestingGuide.html b/docs/TestingGuide.html index 222ccfb52a9..cb880373de3 100644 --- a/docs/TestingGuide.html +++ b/docs/TestingGuide.html @@ -106,14 +106,14 @@ and tcl.

    -

    The tests are located in two separate CVS modules. The basic feature and -regression tests are in the main "llvm" module under the directory -llvm/test. A more comprehensive test suite that includes whole -programs in C and C++ is in the llvm-test module. This module should -be checked out to the llvm/projects directory. When you -configure the llvm module, the llvm-test module -will be automatically configured. Alternatively, you can configure the - llvm-test module manually.

    +

    The tests are located in two separate Subversion modules. The basic feature + and regression tests are in the main "llvm" module under the directory + llvm/test. A more comprehensive test suite that includes whole +programs in C and C++ is in the test-suite module. This module should +be checked out to the llvm/projects directory as llvm-test (for +historical purpose). When you configure the llvm module, +the llvm-test directory will be automatically configured. +Alternatively, you can configure the test-suite module manually.

    To run all of the simple tests in LLVM using DejaGNU, use the master Makefile in the llvm/test directory:

    @@ -140,7 +140,7 @@ programs), run the llvm-test tests:
    
 
 
     % 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.
    
 
-
    All "whole program" tests are located in the llvm-test CVS
+
    All "whole program" tests are located in the test-suite Subversion
 module.
    @@ -238,8 +238,8 @@ subtrees of the test suite directory tree are as follows:

    piece of LLVM assembly language code, often distilled from an actual application or benchmark.

    -
  • llvm-test -

    The llvm-test CVS module contains programs that can be compiled +

  • test-suite +

    The test-suite 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.

    1. cd into the llvm/projects directory
      2. -
    2. check out the llvm-test module with:
      - cvs -d :pserver:anon@llvm.org:/var/cvs/llvm co -PR llvm-test
      +
    3. check out the test-suite module with:
      + svn co http://llvm.org/svn/llvm-project/test-suite/trunk llvm-test
      This will get the test suite into llvm/projects/llvm-test
    4. configure the test suite. You can do this one of two ways:
        @@ -760,24 +760,15 @@ as keep track of LLVM's progress over time.

        machine, take a look at the comments at the top of the utils/NewNightlyTest.pl file. If you decide to set up a nightly tester please choose a unique nickname and invoke utils/NewNightlyTest.pl -with the "-nickname [yournickname]" command line option. We usually run it -from a crontab entry that looks like this:

        +with the "-nickname [yournickname]" command line option. -
        -
        -5 3 * * *  $HOME/llvm/utils/NewNightlyTest.pl -parallel -nickname Nickname \
-           $CVSROOT $HOME/buildtest $HOME/cvs/testresults
-
        -
        - -

        Or, you can create a shell script to encapsulate the running of the script. +

        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:

         #!/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>&1 > output.log
+   -nickname NightlyTester -noexternals > output.log 2>&1
        diff --git a/docs/index.html b/docs/index.html index 75451ad0c18..e3da6ac9b55 100644 --- a/docs/index.html +++ b/docs/index.html @@ -161,8 +161,7 @@ href="http://llvm.org/doxygen/inherits.html">classes) (tarball) -
      1. CVSWeb CVS Tree -Browser
        2. +
      2. ViewVC Repository Browser
        3. @@ -246,9 +245,9 @@ Patches Archive: 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. -
      3. The CVS Commits +
      4. The Commits Archive: 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.