Document the subtarget features better, make sure that 64-bit mode, 64-bit
[oota-llvm.git] / docs / GettingStarted.html
index 62591eb8aef79648ed47c0ac8553bb2f999914ee..5297fbfa12713e7400291102aa0606bba090b559 100644 (file)
@@ -231,6 +231,12 @@ software you will need.</p>
   <td>PowerPC</td>
   <td>GCC</td>
 </tr>
+<tr>
+  <td>MacOS X<sup><a href="#pf_2">2</a></sup></td>
+  <td>x86</td>
+  <td>GCC</td>
+
+</tr>
 <tr>
   <td>Cygwin/Win32</td>
   <td>x86<sup><a href="#pf_1">1</a></sup></td>
@@ -281,6 +287,11 @@ software you will need.</p>
   <td>Itanium (IA-64)</td>
   <td>GCC</td>
 </tr>
+<tr>
+  <td>HP-UX<sup><a href="#pf_7">7</a></sup></td>
+  <td>Itanium (IA-64)</td>
+  <td>HP aCC</td>
+</tr>
 </table>
 
 <p><b>Notes:</b></p>
@@ -302,9 +313,9 @@ if necessary.</li>
 </div>
 
 <p>Note that you will need about 1-3 GB of space for a full LLVM build in Debug
-mode, depending on the system (because of all the debug info), and the libraries
-appear in more than one of the tools that get linked, so there is some
-duplication.  If you do not need many of the tools and you are space-conscious,
+mode, depending on the system (it is so large because of all the debugging
+information and the fact that the libraries are statically linked into multiple
+tools).  If you do not need many of the tools and you are space-conscious,
 you can disable them individually in <tt>llvm/tools/Makefile</tt>.  The Release
 build requires considerably less space.</p>
 
@@ -343,6 +354,12 @@ href="CFEBuildInstrs.html">try to compile it</a> on your platform.</p>
       <td>C/C++ compiler<sup><a href="#sf1">1</a></sup></td>
     </tr>
 
+    <tr>
+      <td><a href="http://www.gnu.org/software/texinfo">TeXinfo</a></td>
+      <td>4.5</td>
+      <td>For building the CFE</td>
+    </tr>
+
     <tr>
       <td><a href="http://www.gnu.org/software/flex">Flex</a></td>
       <td>2.5.4</td>
@@ -351,7 +368,7 @@ href="CFEBuildInstrs.html">try to compile it</a> on your platform.</p>
 
     <tr>
       <td><a href="http://www.gnu.org/software/bison/bison.html">Bison</a></td>
-      <td>1.35</td>
+      <td>1.28, 1.35, 1.75, 1.875d, 2.0, or 2.1<br>(not 1.85 or 1.875)</td>
       <td>YACC compiler</td>
     </tr>
 
@@ -469,9 +486,9 @@ href="CFEBuildInstrs.html">try to compile it</a> on your platform.</p>
 
 <p>LLVM is very demanding of the host C++ compiler, and as such tends to expose
 bugs in the compiler.  In particular, several versions of GCC crash when trying
-to compile LLVM.  We routinely use GCC 3.3.3 and GCC 3.4.0 and have had success
-with them (however, see below).  Other versions of GCC will probably
-work as well.  GCC versions listed
+to compile LLVM.  We routinely use GCC 3.3.3, 3.4.0, and Apple 4.0.1 
+successfully with them (however, see below).  Other versions of GCC will 
+probably work as well.  GCC versions listed
 here are known to not work.  If you are using one of these versions, please try
 to upgrade your GCC to something more recent.  If you run into a problem with a
 version of GCC not listed here, please <a href="mailto:llvmdev@cs.uiuc.edu">let
@@ -496,6 +513,8 @@ the "<tt>convert_from_eh_region_ranges_1</tt>" GCC function.</p>
    possibly others) does not compile LLVM correctly (it appears that exception 
    handling is broken in some cases).  Please download the FSF 3.3.3 or upgrade
    to a newer version of GCC.</p>
+<p><b>IA-64 GCC 4.0.0</b>: The IA-64 version of GCC 4.0.0 is known to
+   miscompile LLVM.</p>
 </div>
 
 
@@ -569,9 +588,10 @@ variables.
 <dl>
   <dt><tt>LLVM_LIB_SEARCH_PATH</tt>=<tt>/path/to/your/bytecode/libs</tt></dt>
   <dd>[Optional] This environment variable helps LLVM linking tools find the
-  locations of your bytecode libraries. It is provided only a
+  locations of your bytecode libraries. It is provided only as a
   convenience since you can specify the paths using the -L options of the
-  tools and the C/C++ front-end will use the bytecode files installed in its
+  tools and the C/C++ front-end will automatically use the bytecode files
+  installed in its
   <tt>lib</tt> directory.</dd>
 </dl>
 
@@ -603,18 +623,18 @@ compressed with the gzip program.
   <dt><tt>cfrontend-x.y.source.tar.gz</tt></dt>
   <dd>Source release of the GCC front end.<br/></dd>
 
-  <dt><tt>cfrontend-x.y.sparc-sun-solaris2.8.tar.gz</tt></dt>
-  <dd>Binary release of the GCC front end for Solaris/Sparc.
-  <br/></dd>
-
   <dt><tt>cfrontend-x.y.i686-redhat-linux-gnu.tar.gz</tt></dt>
   <dd>Binary release of the GCC front end for Linux/x86.<br/></dd>
 
-  <dt><tt>cfrontend-x.y.i386-unknown-freebsd5.1.tar.gz</tt></dt>
-  <dd>Binary release of the GCC front end for FreeBSD/x86.<br/></dd>
+  <dt><tt>llvm-gcc4-x.y.source.tar.gz</tt></dt>
+  <dd>Source release of the llvm-gcc4 front end.  See README.LLVM in the root
+      directory for build instructions.<br/></dd>
 
-  <dt><tt>cfrontend-x.y.powerpc-apple-darwin7.6.0.tar.gz</tt></dt>
-  <dd>Binary release of the GCC front end for MacOS X/PPC.<br/></dd>
+  <dt><tt>llvm-gcc4-x.y.powerpc-apple-darwin8.6.0.tar.gz</tt></dt>
+  <dd>Binary release of the llvm-gcc4 front end for MacOS X/PowerPC.<br/></dd>
+
+  <dt><tt>llvm-gcc4-x.y.i686-apple-darwin8.6.1.tar.gz</tt></dt>
+  <dd>Binary release of the llvm-gcc4 front end for MacOS X/X86.<br/></dd>
 </dl>
 
 </div>
@@ -647,6 +667,8 @@ revision), you can specify a label.  The following releases have the following
 labels:</p>
 
 <ul>
+<li>Release 1.7: <b>RELEASE_17</b></li>
+<li>Release 1.6: <b>RELEASE_16</b></li>
 <li>Release 1.5: <b>RELEASE_15</b></li>
 <li>Release 1.4: <b>RELEASE_14</b></li>
 <li>Release 1.3: <b>RELEASE_13</b></li>
@@ -665,8 +687,7 @@ you get it from the CVS repository:</p>
 configured by the LLVM configure script as well as automatically updated when
 you run <tt>cvs update</tt>.</p>
 
-<p>If you would like to get the GCC front end source code, you can also get it
-from the CVS repository:</p>
+<p>If you would like to get the GCC 3.4 front end source code, you can also get it from the CVS repository:</p>
 
 <pre>
   cvs -z3 -d :pserver:anon@llvm-cvs.cs.uiuc.edu:/var/cvs/llvm co llvm-gcc
@@ -677,22 +698,6 @@ instructions</a> to successfully build the LLVM GCC front-end.</p>
 
 </div>
 
-<!-- ======================================================================= -->
-<div class="doc_subsubsection">
-  <a name="mirrors">LLVM CVS Mirrors</a>
-</div>
-
-<div class="doc_text">
-
-<p>If the main CVS server is overloaded or inaccessible, you can try one of
-these user-hosted mirrors:</p>
-
-<ul>
-<li><a href="http://llvm.x10sys.com/">Mirror hosted by eXtensible Systems
-Inc.</a></li>
-</ul>
-</div>
-
 <!-- ======================================================================= -->
 <div class="doc_subsection">
   <a name="installcf">Install the GCC Front End</a>
@@ -781,11 +786,12 @@ script to configure the build system:</p>
   <a href="CFEBuildInstrs.html">Bootstrapping the LLVM C/C++ Front-End</a>
   for details on building the C/C++ Front End.</dd>
   <dt><i>--with-tclinclude</i></dt>
-  <dd>Path to the tcl include directory under which the <tt>tclsh</tt> can be
+  <dd>Path to the tcl include directory under which <tt>tclsh</tt> can be
   found. Use this if you have multiple tcl installations on your machine and you
   want to use a specific one (8.x) for LLVM. LLVM only uses tcl for running the
   dejagnu based test suite in <tt>llvm/test</tt>. If you don't specify this
-  option, the LLVM configure script will search for tcl 8.4 and 8.3 releases.
+  option, the LLVM configure script will search for the tcl 8.4 and 8.3
+  releases.
   <p></p>
   </dd>
   <dt><i>--enable-optimized</i></dt>
@@ -795,6 +801,11 @@ script to configure the build system:</p>
     unoptimized build (also known as a debug build).
     <p></p>
   </dd>
+  <dt><i>--enable-debug-runtime</i></dt>
+  <dd>
+    Enables debug symbols in the runtime libraries. The default is to strip
+    debug symbols from the runtime libraries. 
+  </dd>
   <dt><i>--enable-jit</i></dt>
   <dd>
     Compile the Just In Time (JIT) compiler functionality.  This is not
@@ -810,7 +821,7 @@ script to configure the build system:</p>
   native compiler (no cross-compiler targets available). The "native" target is 
   selected as the target of the build host. You can also specify a comma 
   separated list of target names that you want available in llc. The target 
-  names use all lower case. The current set is of targets is: <br/>
+  names use all lower case. The current set of targets is: <br/>
   <tt>alpha, ia64, powerpc, skeleton, sparc, x86</tt>.
   <p></p></dd>
   <dt><i>--enable-doxygen</i></dt>
@@ -934,6 +945,11 @@ declaring variables on the command line.  The following are some examples:</p>
   Perform a Release (Optimized) build.
   <p>
 
+  <dt><tt>gmake ENABLE_OPTIMIZED=1 DISABLE_ASSERTIONS=1</tt>
+  <dd>
+  Perform a Release (Optimized) build without assertions enabled.
+  <p>
+
   <dt><tt>gmake ENABLE_PROFILING=1</tt>
   <dd>
   Perform a Profiling build.
@@ -1059,7 +1075,7 @@ Cummings for pointing this out!
 
 <p>One useful source of information about the LLVM source base is the LLVM <a
 href="http://www.doxygen.org">doxygen</a> documentation available at <tt><a
-href="http://llvm.cs.uiuc.edu/doxygen/">http://llvm.cs.uiuc.edu/doxygen/</a></tt>.
+href="http://llvm.org/doxygen/">http://llvm.org/doxygen/</a></tt>.
 The following is a brief introduction to code layout:</p>
 
 </div>
@@ -1139,9 +1155,9 @@ different <a href="#tools">tools</a>.</p>
 
   <dt><tt><b>llvm/lib/Target/</b></tt></dt>
   <dd> This directory contains files that describe various target architectures
-  for code generation.  For example, the <tt>llvm/lib/Target/SparcV9</tt> 
-  directory holds the Sparc machine description while
-  <tt>llvm/lib/Target/CBackend</tt> implements the LLVM-to-C converter</dd>
+  for code generation.  For example, the <tt>llvm/lib/Target/X86</tt> 
+  directory holds the X86 machine description while
+  <tt>llvm/lib/Target/CBackend</tt> implements the LLVM-to-C converter.</dd>
     
   <dt><tt><b>llvm/lib/CodeGen/</b></tt></dt>
   <dd> This directory contains the major parts of the code generator: Instruction 
@@ -1244,8 +1260,8 @@ information is in the <a href="CommandGuide/index.html">Command Guide</a>.</p>
   all from one command line. <tt>llvmc</tt> also takes care of processing the
   dependent libraries found in bytecode. This reduces the need to get the
   traditional <tt>-l&lt;name&gt;</tt> options right on the command line. Please
-  note that this tool is new in 1.4 and considered experimental. It will be
-  fully supported in 1.5.</dd>
+  note that this tool, while functional, is still experimental and not feature
+  complete.</dd>
 
   <dt><tt><b>llvm-ar</b></tt></dt>
   <dd>The archiver produces an archive containing
@@ -1264,9 +1280,8 @@ information is in the <a href="CommandGuide/index.html">Command Guide</a>.</p>
   <dd><tt>llvm-ld</tt> is very similar to gccld and provides a general purpose
   and extensible linker for LLVM. This is the linker invoked by <tt>llvmc</tt>.
   It allows optimization modules to be loaded so that language specific
-  optimizations can be applied at link time. Please note that this tool is new
-  in LLVM 1.4 and still considered experimental. It will be fully supported in
-  LLVM 1.5.</dd>
+  optimizations can be applied at link time. This tool is considered
+  experimental.</dd>
 
   <dt><tt><b>llvm-link</b></tt></dt>
   <dd><tt>llvm-link</tt>, not surprisingly, links multiple LLVM modules into 
@@ -1284,7 +1299,7 @@ information is in the <a href="CommandGuide/index.html">Command Guide</a>.</p>
 
   <dt><tt><b>llc</b></tt></dt>
   <dd> <tt>llc</tt> is the LLVM backend compiler, which
-  translates LLVM bytecode to a SPARC or x86 assembly file, or to C code (with
+  translates LLVM bytecode to a native code assembly file or to C code (with
   the -march=c option).</dd>
 
   <dt><tt><b>llvm-gcc</b></tt></dt>
@@ -1292,8 +1307,7 @@ information is in the <a href="CommandGuide/index.html">Command Guide</a>.</p>
   that has been retargeted to emit LLVM code as the machine code output.  It
   works just like any other GCC compiler, taking the typical <tt>-c, -S, -E,
   -o</tt> options that are typically used.  The source code for the
-  <tt>llvm-gcc</tt> tool is currently not included in the LLVM CVS tree
-  because it is quite large and not very interesting.
+  <tt>llvm-gcc</tt> tool is available as a separate CVS module.
   <blockquote>
     <dl>
       <dt><tt><b>gccas</b></tt></dt>
@@ -1338,11 +1352,6 @@ of the utilities are actually required as part of the build process because they
 are code generators for parts of LLVM infrastructure.</p>
 
 <dl>
-  <dt><tt><b>Burg/</b></tt> <dd><tt>Burg</tt> is an instruction selector
-  generator -- it builds trees on which it then performs pattern-matching to
-  select instructions according to the patterns the user has specified. Burg
-  is currently used in the Sparc V9 backend.<p>
-
   <dt><tt><b>codegen-diff</b></tt> <dd><tt>codegen-diff</tt> is a script
   that finds differences between code that LLC generates and code that LLI
   generates. This is a useful tool if you are debugging one of them,
@@ -1388,7 +1397,7 @@ are code generators for parts of LLVM infrastructure.</p>
   <tt><b>NightlyTestTemplate.html</b></tt> <dd>These files are used in a
   cron script to generate nightly status reports of the functionality of
   tools, and the results can be seen by following the appropriate link on
-  the <a href="http://llvm.cs.uiuc.edu/">LLVM homepage</a>.<p>
+  the <a href="http://llvm.org/">LLVM homepage</a>.<p>
 
   <dt><tt><b>TableGen/</b></tt> <dd>The <tt>TableGen</tt> directory contains
   the tool used to generate register descriptions, instruction set
@@ -1507,9 +1516,9 @@ if you want to write something up!).  For more information about LLVM, check
 out:</p>
 
 <ul>
-  <li><a href="http://llvm.cs.uiuc.edu/">LLVM homepage</a></li>
-  <li><a href="http://llvm.cs.uiuc.edu/doxygen/">LLVM doxygen tree</a></li>
-  <li><a href="http://llvm.cs.uiuc.edu/docs/Projects.html">Starting a Project
+  <li><a href="http://llvm.org/">LLVM homepage</a></li>
+  <li><a href="http://llvm.org/doxygen/">LLVM doxygen tree</a></li>
+  <li><a href="http://llvm.org/docs/Projects.html">Starting a Project
   that Uses LLVM</a></li>
 </ul>
 
@@ -1526,7 +1535,7 @@ out:</p>
 
   <a href="mailto:sabre@nondot.org">Chris Lattner</a><br>
   <a href="http://llvm.x10sys.com/rspencer/">Reid Spencer</a><br>
-  <a href="http://llvm.cs.uiuc.edu">The LLVM Compiler Infrastructure</a><br>
+  <a href="http://llvm.org">The LLVM Compiler Infrastructure</a><br>
   Last modified: $Date$
 </address>
 </body>