[llvm-commits] [llvm-top] r41122 - in /llvm-top/trunk: ./ README.txt

[Reid Spencer]

Author: reid
Date: Thu Aug 16 02:58:29 2007
New Revision: 41122

URL: http://llvm.org/viewvc/llvm-project?rev=41122&view=rev
Log:
Update the documentation to include a description of the options command, fix
some typos and relocate some content. 

Set the svn:ignore property to ignore checked out directories.

Modified:
    llvm-top/trunk/   (props changed)
    llvm-top/trunk/README.txt

Propchange: llvm-top/trunk/

------------------------------------------------------------------------------
--- svn:ignore (original)
+++ svn:ignore Thu Aug 16 02:58:29 2007
@@ -1,3 +1,11 @@
 svn-commit*.tmp
 installed
 .options
+sample
+build.llvm-gcc-4.0
+website
+llvm-gcc-4.0
+test-suite
+build.llvm
+llvm
+support

Modified: llvm-top/trunk/README.txt
URL: http://llvm.org/viewvc/llvm-project/llvm-top/trunk/README.txt?rev=41122&r1=41121&r2=41122&view=diff

==============================================================================
--- llvm-top/trunk/README.txt (original)
+++ llvm-top/trunk/README.txt Thu Aug 16 02:58:29 2007
@@ -20,7 +20,10 @@
   ./get llvm-gcc-4-0
 
 which will check out both llvm and llvm-gcc-4-0 because the latter depends on
-the former. 
+the former.  You can check out any number of modules using the "get" script, 
+for example, like this:
+
+  ./get llvm-gcc-4.0 test-suite stacker
 
 
 In addition to checking out software, there are several more scripts in 
@@ -33,16 +36,19 @@
   get      - check out modules and their dependencies from subversion
   info     - get subversion information about one or more modules
   update   - update one or more modules
+  options  - specify options once that are "sticky" for all scripts.
 
   build    - configure, compile and link one or more modules
   install  - install one or more modules (presumes build already done)
   clean    - clean (remove build products) one or more modules
 
-The first three scripts just work with subversion.  The last three scripts do 
-not dictate how to build, install or clean the modules; that is up to the 
-modules themselves.  The only thing these scripts depend on is a file named 
-ModuleInfo.txt located in each module's top directory. This file can contain 
-the following definitions:
+
+The first four scripts just work with subversion or llvm-top itself.  The last
+three scripts implement an easier method for building, isntalling and cleaning
+the LLVM modules themselves. However, these three do not dictate how to build, 
+install or clean the modules; that is up to the modules themselves.  The only 
+thing these scripts depend on is a file named ModuleInfo.txt located in each 
+module's top directory. This file can contain the following definitions:
 
   DepModule:  - the list of modules this module depends on 
   BuildCmd:   - a command to build (and configure) the module
@@ -61,7 +67,7 @@
 of arguments. The arguments recognized are listed below in the order they
 are recognized by the scripts:
 
-  VEROBSE={verbosity_level}
+  VERBOSE={verbosity_level}
      This controls how verbose the scripts are in their output. The default
      level is 0 which produces no output unless there's an error. At level 1
      you'll get basic confirmation of the action taken. At level 2 you'll get
@@ -89,7 +95,7 @@
      build, install or clean commands.
 
   all
-     This is equivalent to specify all modules in the LLVM subversion 
+     This is equivalent to specifying all modules in the LLVM subversion 
      repository. Careful! All the scripts will check out EVERYTHING in the
      repository. 
 
@@ -111,7 +117,7 @@
 
   3. Specify "all" - all modules will be checked out (careful!)
 
-So, for example:
+So, for example, consider:
 
   ./build llvm-gcc-4.0 ENABLE_OPTIMIZED=1 PREFIX=/my/install/dir VERBOSE=1
 
@@ -120,7 +126,7 @@
   1. Check out the llvm-gcc-4.0 module
   2. Check out the core module because llvm-gcc-4.0 depends on core
   3. Check out the support module because core depends on support
-  4. Build the support module in optimized mode and configured to install
+  4. Build the support module in optimized mode and configure it to install
      into /my/install/dir
   5. Build the core module the same way.
   6. Build the llvm-gcc-4.0 module the same way.
@@ -141,12 +147,6 @@
   java         - Java Front End (unfinished, out of date)
   poolalloc    - The pooled allocator from Chris Lattner's thesis
 
-
-You can check out any number of modules using the "get" script, for example,
-like this:
-
-  ./get llvm-gcc-4.0 test-suite stacker
-
 -----------------------------------------------------------------------------
 
 Some Other Useful URLS