* Keep LiveVariable information more up-to-date and consistent
[oota-llvm.git] / docs / GettingStarted.html
index d274fee0b7580f71a1d2ef8a4223efde2edb5f4e..d7d47aefadc4821044a4705b129d8566ab8f49b7 100644 (file)
     <!--=====================================================================-->
 
     Here's the short story for getting up and running quickly with LLVM:
-    <ul>
+    <ol>
     <li>Find the path to the CVS repository containing LLVM (we'll call this <i>CVSROOTDIR</i>).
     <li><tt>cd <i>where-you-want-llvm-to-live</i></tt>
     <li><tt>cvs -d <i>CVSROOTDIR</i> checkout llvm</tt>
-    <li>Edit <tt>llvm/Makefile.config</tt> to set local paths if necessary.
     <li><tt>cd llvm</tt>
+    <li>Edit <tt>Makefile.config</tt> to set local paths.  This includes
+        setting the install location of the C frontend, and the various paths
+        to the C and C++ compilers used to build LLVM itself.
+    <li>Set your LLVM_LIB_SEARCH_PATH environment variable.
     <li><tt>gmake -k |& tee gnumake.out
            &nbsp;&nbsp;&nbsp;# this is csh or tcsh syntax</tt>
-    </ul>
+    </ol>
 
     <p>See <a href="#environment">Setting up your environment</a> on tips to
     simplify working with the LLVM front-end and compiled tools.  See the
     <p><li><i>PURIFY</i>       = Path to the purify program.
     </ul>
 
+    In addition to settings in this file, you must set a
+    <tt>LLVM_LIB_SEARCH_PATH</tt> environment variable in your startup scripts.
+    This environment variable is used to locate "system" libraries like
+    "<tt>-lc</tt>" and "<tt>-lm</tt>" when linking.  This variable should be set
+    to the absolute path for the bytecode-libs subdirectory of the C front-end
+    install.  For example,
+    <tt>/home/vadve/lattner/local/x86/llvm-gcc/bytecode-libs</tt> for the X86
+    version of the C front-end, on our research machines.<p>
+
     <!------------------------------------------------------------------------->
     <h3><a name="objfiles">The location for LLVM object files</a></h3>
     <!------------------------------------------------------------------------->
         <tt>x.o</tt> file (which is an LLVM bytecode file that can be
         disassembled or manipulated just like any other bytecode file).  The
         command line interface to <tt>gccas</tt> is designed to be as close as
-        possible to the <b>system</b> <tt>as</tt> utility so that the gcc
+        possible to the <b>system</b> '<tt>as</tt>' utility so that the gcc
         frontend itself did not have to be modified to interface to a "wierd"
         assembler.<p>
 
 
            <!-- Created: Mon Jul  1 02:29:02 CDT 2002 -->
            <!-- hhmts start -->
-Last modified: Thu Sep 19 14:55:19 CDT 2002
+Last modified: Sun May 11 16:49:46 CDT 2003
 <!-- hhmts end -->
   </body>
 </html>