let us get some do what I meant not what I said stuff checked in. You would think...
[oota-llvm.git] / docs / GettingStarted.html
index e49608a624d53f9fda3eba1014f160cf171679a2..369b4030ff7315366f0f0b292dd2dcbfada31df3 100644 (file)
@@ -118,7 +118,7 @@ and performance.
       </li>
       <li><tt>cd cfrontend/<i>platform</i><br>
         ./fixheaders</tt></li>
-      <li>Add the cfrontend's "bin" directory to your PATH variable</li>
+      <li>Add the cfrontend's "bin" directory to your PATH variable.</li>
     </ol></li>
 
   <li>Get the LLVM Source Code
@@ -156,7 +156,7 @@ and performance.
         <tt>/usr/local</tt>).</p></li>
         <li><tt>--with-llvmgccdir=<i>directory</i></tt>
         <p>Optionally, specify for <i>directory</i> the full pathname of the 
-        C/C++ FrontEnd installation to use with this LLVM configuration. If
+        C/C++ front end installation to use with this LLVM configuration. If
         not specified, the PATH will be searched.</p></li>
         <li><tt>--enable-spec2000=<i>directory</i></tt>
             <p>Enable the SPEC2000 benchmarks for testing.  The SPEC2000
@@ -270,6 +270,22 @@ software you will need.</p>
   <td>PowerPC</td>
   <td>GCC</td>
 </tr>
+
+<tr>
+  <td>Linux<sup><a href="#pf_7">7</a></sup></td>
+  <td>Alpha</td>
+  <td>GCC</td>
+</tr>
+<tr>
+  <td>Linux<sup><a href="#pf_7">7</a></sup></td>
+  <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>
@@ -285,21 +301,15 @@ up</a></li>
 <li><a name="pf_6">The port is done using the MSYS shell. 
 <a href="http://www.mingw.org/MinGWiki/">Download</a> and install 
 bison (excl. M4.exe) and flex in that order.  Build binutils-2.15 from source,
-if necessary.  If you need to create a library for an MS DLL, do the following:
-<ul>
-<li><tt>pexports /C/WINNT/SYSTEM32/file.dll | sed "s/^_//" &gt;
-/C/MinGW/lib/file.def</tt></li>
-<li>Edit file and append @&lt;ordinal&gt; to the missing function name</li>
-<li><tt>dlltool.exe -k -d /C/MinGW/lib/file.def -l
-/C/MinGW/lib/libfile.a.</tt></li>
-</ul></li>
+if necessary.</li>
+<li><a name="pf_7">Native code generation exists but is not complete.</a></li>
 </ol>
 </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>
 
@@ -338,6 +348,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>
@@ -346,7 +362,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, or 2.0 (not 1.85)</td>
       <td>YACC compiler</td>
     </tr>
 
@@ -465,7 +481,8 @@ 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.  Other versions of GCC will probably work as well.  GCC versions listed
+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
@@ -482,6 +499,16 @@ problems in the STL that effectively prevent it from compiling LLVM.
 <p><b>GCC 3.3.2</b>: This version of GCC suffered from a <a 
 href="http://gcc.gnu.org/PR13392">serious bug</a> which causes it to crash in
 the "<tt>convert_from_eh_region_ranges_1</tt>" GCC function.</p>
+
+<p><b>Cygwin GCC 3.3.3</b>: The version of GCC 3.3.3 commonly shipped with 
+   Cygwin does not work.  Please <a href="CFEBuildInstrs.html#cygwin">upgrade 
+   to a newer version</a> if possible.</p>
+<p><b>SuSE GCC 3.3.3</b>: The version of GCC 3.3.3 shipped with SuSE 9.1 (and 
+   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>
 
 
@@ -555,9 +582,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>
 
@@ -599,7 +627,7 @@ compressed with the gzip program.
   <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>cfrontend-x.y.powerpc-apple-darwin7.6.0.tar.gz</tt></dt>
+  <dt><tt>cfrontend-x.y.powerpc-apple-darwin7.8.0.tar.gz</tt></dt>
   <dd>Binary release of the GCC front end for MacOS X/PPC.<br/></dd>
 </dl>
 
@@ -633,6 +661,8 @@ revision), you can specify a label.  The following releases have the following
 labels:</p>
 
 <ul>
+<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>
 <li>Release 1.2: <b>RELEASE_12</b></li>
@@ -766,11 +796,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>
@@ -780,6 +811,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
@@ -788,6 +824,16 @@ script to configure the build system:</p>
     to explicitly enable it if you want it.
     <p></p>
   </dd>
+  <dt><i>--enable-targets=</i><tt>target-option</tt></dt>
+  <dd>Controls which targets will be built and linked into llc. The default 
+  value for <tt>target_options</tt> is "all" which builds and links all 
+  available targets.  The value "host-only" can be specified to build only a 
+  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 of targets is: <br/>
+  <tt>alpha, ia64, powerpc, skeleton, sparc, x86</tt>.
+  <p></p></dd>
   <dt><i>--enable-doxygen</i></dt>
   <dd>Look for the doxygen program and enable construction of doxygen based
   documentation from the source code. This is disabled by default because 
@@ -1116,7 +1162,7 @@ different <a href="#tools">tools</a>.</p>
   <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>
+  <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 
@@ -1182,8 +1228,8 @@ end to compile.</p>
   module contains a comprehensive correctness, performance, and benchmarking
   test
   suite for LLVM. It is a separate CVS module because not every LLVM user is
-  interested in downloading or building such a comprehensive test. For further
-  details on this test suite, please see the 
+  interested in downloading or building such a comprehensive test suite. For
+  further details on this test suite, please see the 
   <a href="TestingGuide.html">Testing Guide</a> document.</p>
 </div>
 
@@ -1219,8 +1265,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
@@ -1239,9 +1285,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 
@@ -1259,7 +1304,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>
@@ -1267,8 +1312,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>