Start converting to new error handling API.
[oota-llvm.git] / docs / GettingStarted.html
index 79fb371e264b74ef997557a2f79e4e66b0ded8b2..1cca5ac8e0910073a4ceb501f893f04eac70ddf8 100644 (file)
@@ -114,10 +114,10 @@ and performance.
   <li>Read the documentation.</li>
   <li>Read the documentation.</li>
   <li>Remember that you were warned twice about reading the documentation.</li>
-  <li>Install the llvm-gcc4.2 front end if you intend to compile C or C++:
+  <li>Install the llvm-gcc-4.2 front end if you intend to compile C or C++:
     <ol>
       <li><tt>cd <i>where-you-want-the-C-front-end-to-live</i></tt></li>
-      <li><tt>gunzip --stdout llvm-gcc.<i>platform</i>.tar.gz | tar -xvf -</tt>
+      <li><tt>gunzip --stdout llvm-gcc-4.2-<i>version</i>-<i>platform</i>.tar.gz | tar -xvf -</tt>
       </li>
       <li>Note: If the binary extension is ".bz" use bunzip2 instead of gunzip.</li>
       <li>Add llvm-gcc's "bin" directory to your PATH variable.</li>
@@ -159,7 +159,8 @@ and performance.
         <li><tt>--with-llvmgccdir=<i>directory</i></tt>
         <p>Optionally, specify for <i>directory</i> the full pathname of the 
         C/C++ front end installation to use with this LLVM configuration. If
-        not specified, the PATH will be searched.</p></li>
+        not specified, the PATH will be searched.  This is only needed if you
+        want to run the testsuite or do some special kinds of LLVM builds.</p></li>
         <li><tt>--enable-spec2000=<i>directory</i></tt>
             <p>Enable the SPEC2000 benchmarks for testing.  The SPEC2000
             benchmarks should be available in
@@ -307,11 +308,7 @@ up</a></li>
 <li><a name="pf_3">No native code generation</a></li>
 <li><a name="pf_4">Build is not complete: one or more tools do not link or function</a></li>
 <li><a name="pf_5">The GCC-based C/C++ frontend does not build</a></li>
-<li><a name="pf_6">The port is done using the MSYS shell.</a>
-<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. Bison &amp; flex can be also grabbed from GNUWin32 sf.net 
-project.</li>
+<li><a name="pf_6">The port is done using the MSYS shell.</a></li>
 <li><a name="pf_7">Native code generation exists but is not complete.</a></li>
 <li><a name="pf_8">Binutils</a> up to post-2.17 has bug in bfd/cofflink.c
     preventing LLVM from building correctly. Several workarounds have been
@@ -330,9 +327,9 @@ project.</li>
 <p>Note that you will need about 1-3 GB of space for a full LLVM build in Debug
 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>
+tools).  If you do not need many of the tools and you are space-conscious, you
+can pass <tt>ONLY_TOOLS="tools you need"</tt> to make.  The Release build
+requires considerably less space.</p>
 
 <p>The LLVM suite <i>may</i> compile on other platforms, but it is not
 guaranteed to do so.  If compilation is successful, the LLVM utilities should be
@@ -375,18 +372,6 @@ href="GCCFEBuildInstrs.html">try to compile it</a> on your platform.</p>
       <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>
-      <td>LEX compiler</td>
-    </tr>
-
-    <tr>
-      <td><a href="http://www.gnu.org/software/bison/bison.html">Bison</a></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>
-
     <tr>
       <td><a href="http://subversion.tigris.org/project_packages.html">SVN</a></td>
       <td>&ge;1.3</td>
@@ -558,8 +543,11 @@ platforms compiling md5.c gets a mangled constant.</p>
 <p><b>GCC 4.1.2 (20061115 (prerelease) (Debian 4.1.1-21)) on Debian</b>: Appears
 to miscompile parts of LLVM 2.4. One symptom is ValueSymbolTable complaining
 about symbols remaining in the table on destruction.</p>
-<p><b>GCC 4.1.2 20071124 (Red Hat 4.1.2-42)</b>: Suffers from the same symptons
+<p><b>GCC 4.1.2 20071124 (Red Hat 4.1.2-42)</b>: Suffers from the same symptoms
 as the previous one. It appears to work with ENABLE_OPTIMIZED=0 (the default).</p>
+<p><b>Cygwin GCC 4.3.2 20080827 (beta) 2</b>:
+  Users <a href="http://llvm.org/PR4145">reported</a> various problems related
+  with link errors when using this GCC version.</p>
 
 <p><b>GNU ld 2.16.X</b>. Some 2.16.X versions of the ld linker will produce very
 long warning messages complaining that some ".gnu.linkonce.t.*" symbol was
@@ -572,6 +560,12 @@ href="http://sourceware.org/bugzilla/show_bug.cgi?id=3111">a bug</a> which
 causes huge link times (minutes instead of seconds) when building LLVM.  We
 recommend upgrading to a newer version (2.17.50.0.4 or later).</p>
 
+<p><b>GNU Binutils 2.19.1 Gold</b>: This version of Gold contained
+<a href="http://sourceware.org/bugzilla/show_bug.cgi?id=9836">a bug</a>
+which causes intermittent failures when building LLVM with position independent
+code.  The symptom is an error about cyclic dependencies.  We recommend
+upgrading to a newer version of Gold.</p>
+
 </div>
 
 
@@ -672,17 +666,17 @@ compressed with the gzip program.
 <p>The files are as follows, with <em>x.y</em> marking the version number:
 <dl>
   <dt><tt>llvm-x.y.tar.gz</tt></dt>
-  <dd>Source release for the LLVM libraries and tools.<br/></dd>
+  <dd>Source release for the LLVM libraries and tools.<br></dd>
 
   <dt><tt>llvm-test-x.y.tar.gz</tt></dt>
   <dd>Source release for the LLVM test suite.</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>llvm-gcc-4.2-x.y.source.tar.gz</tt></dt>
+  <dd>Source release of the llvm-gcc-4.2 front end.  See README.LLVM in the root
+      directory for build instructions.<br></dd>
 
-  <dt><tt>llvm-gcc4-x.y-platform.tar.gz</tt></dt>
-  <dd>Binary release of the llvm-gcc4 front end for a specific platform.<br/></dd>
+  <dt><tt>llvm-gcc-4.2-x.y-platform.tar.gz</tt></dt>
+  <dd>Binary release of the llvm-gcc-4.2 front end for a specific platform.<br></dd>
 
 </dl>
 
@@ -696,7 +690,7 @@ compressed with the gzip program.
 <div class="doc_text">
 
 <p>If you have access to our Subversion repository, you can get a fresh copy of
-the entire source code.  All you need to do is check it out from Subvresion as
+the entire source code.  All you need to do is check it out from Subversion as
 follows:</p>
 
 <ul>
@@ -714,9 +708,11 @@ test directories, and local copies of documentation files.</p>
 <p>If you want to get a specific release (as opposed to the most recent
 revision), you can checkout it from the '<tt>tags</tt>' directory (instead of
 '<tt>trunk</tt>'). The following releases are located in the following
-  subdirectories of the '<tt>tags</tt>' directory:</p>
+subdirectories of the '<tt>tags</tt>' directory:</p>
 
 <ul>
+<li>Release 2.5: <b>RELEASE_25</b></li>
+<li>Release 2.4: <b>RELEASE_24</b></li>
 <li>Release 2.3: <b>RELEASE_23</b></li>
 <li>Release 2.2: <b>RELEASE_22</b></li>
 <li>Release 2.1: <b>RELEASE_21</b></li>
@@ -770,7 +766,7 @@ main LLVM repository.</p>
 
 <ol>
   <li><tt>cd <i>where-you-want-the-front-end-to-live</i></tt></li>
-  <li><tt>gunzip --stdout llvmgcc-<i>version</i>.<i>platform</i>.tar.gz | tar -xvf
+  <li><tt>gunzip --stdout llvm-gcc-4.2-<i>version</i>-<i>platform</i>.tar.gz | tar -xvf
       -</tt></li>
 </ol>
 
@@ -856,9 +852,11 @@ script to configure the build system:</p>
   </dd>
   <dt><i>--enable-optimized</i></dt>
   <dd>
-    Enables optimized compilation by default (debugging symbols are removed
-    and GCC optimization flags are enabled).  The default is to use an
-    unoptimized build (also known as a debug build).
+    Enables optimized compilation (debugging symbols are removed
+    and GCC optimization flags are enabled). Note that this is the default 
+    setting     if you are using the LLVM distribution. The default behavior 
+    of an Subversion checkout is to use an unoptimized build (also known as a 
+    debug build).
     <br><br>
   </dd>
   <dt><i>--enable-debug-runtime</i></dt>
@@ -881,7 +879,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 of targets is: <br/>
+  names use all lower case. The current set of targets is: <br>
   <tt>alpha, ia64, powerpc, skeleton, sparc, x86</tt>.
   <br><br></dd>
   <dt><i>--enable-doxygen</i></dt>
@@ -926,10 +924,12 @@ builds:</p>
 <dl>
     <dt>Debug Builds
     <dd>
-    These builds are the default when one types <tt>gmake</tt> (unless the
-    <tt>--enable-optimized</tt> option was used during configuration).  The
-    build system will compile the tools and libraries with debugging
-    information.
+    These builds are the default when one is using an Subversion checkout and 
+    types <tt>gmake</tt> (unless the <tt>--enable-optimized</tt> option was 
+    used during configuration).  The build system will compile the tools and 
+    libraries with debugging information.  To get a Debug Build using the
+    LLVM distribution the <tt>--disable-optimized</tt> option must be passed
+    to <tt>configure</tt>.
     <br><br>
 
     <dt>Release (Optimized) Builds
@@ -939,6 +939,7 @@ builds:</p>
     <tt>gmake</tt> command line.  For these builds, the build system will
     compile the tools and libraries with GCC optimizations enabled and strip
     debugging information from the libraries and executables it generates. 
+    Note that Release Builds are default when using an LLVM distribution.
     <br><br>
 
     <dt>Profile Builds
@@ -1015,6 +1016,11 @@ declaring variables on the command line.  The following are some examples:</p>
   <dd>
   Perform a Release (Optimized) build without assertions enabled.
   <br><br>
+  <dt><tt>gmake ENABLE_OPTIMIZED=0</tt>
+  <dd>
+  Perform a Debug build.
+  <br><br>
 
   <dt><tt>gmake ENABLE_PROFILING=1</tt>
   <dd>
@@ -1045,43 +1051,16 @@ that directory that is out of date.</p>
 </div>
 
 <div class="doc_text">
-  <p>It is possible to cross-compile LLVM. That is, you can create LLVM
-  executables and libraries for a platform different than the one one which you
-  are compiling.  To do this, a few additional steps are 
-  required. <sup><a href="#ccn_1">1</a></sup> To cross-compile LLVM, use
-  these instructions:</p>
-  <ol>
-    <li>Configure and build LLVM as a native compiler. You will need
-    just <tt>TableGen</tt> from that build.
-      <ul>
-        <li>If you have <tt>$LLVM_OBJ_ROOT=$LLVM_SRC_ROOT</tt> just execute 
-          <tt>make -C utils/TableGen</tt> after configuring.</li>
-        <li>Otherwise you will need to monitor building process and terminate 
-          it just after <tt>TableGen</tt> was built.</li>
-      </ul>
-    </li>
-    <li>Copy the TableGen binary to somewhere safe (out of your build tree).
-    </li>
-    <li>Configure LLVM to build with a cross-compiler. To do this, supply the
-    configure script with <tt>--build</tt> and <tt>--host</tt> options that
-    are different. The values of these options must be legal target triples 
-    that your GCC compiler supports.</li>
-    <li>Put the saved <tt>TableGen</tt> executable into the
-    into <tt>$LLVM_OBJ_ROOT/{BUILD_TYPE}/bin</tt> directory (e.g. into 
-    <tt>.../Release/bin</tt> for a Release build).</li>
-    <li>Build LLVM  as usual.</li>
-  </ol>
-  <p>The result of such a build will produce executables that are not executable
-  on your build host (--build option) but can be executed on your compile host
+  <p>It is possible to cross-compile LLVM itself. That is, you can create LLVM
+  executables and libraries to be hosted on a platform different from the
+  platform where they are build (a Canadian Cross build). To configure a
+  cross-compile, supply the configure script with <tt>--build</tt> and
+  <tt>--host</tt> options that are different. The values of these options must
+  be legal target triples that your GCC compiler supports.</p>
+
+  <p>The result of such a build is executables that are not runnable on
+  on the build host (--build option) but can be executed on the compile host
   (--host option).</p>
-  <p><b>Notes:</b></p>
-  <div class="doc_notes">
-    <ol>
-      <li><a name="ccn_1">Cross-compiling</a> was tested only with Linux as 
-      build platform and Windows as host using mingw32 cross-compiler. Other
-      combinations have not been tested.</li>
-    </ol>
-  </div>
 </div>
 
 <!-- ======================================================================= -->
@@ -1411,7 +1390,7 @@ information is in the <a href="CommandGuide/index.html">Command Guide</a>.</p>
   <dd><tt>opt</tt> reads LLVM bitcode, applies a series of LLVM to LLVM 
   transformations (which are specified on the command line), and then outputs 
   the resultant bitcode.  The '<tt>opt --help</tt>' command is a good way to 
-  get a list of the program transformations available in LLVM.<br/>
+  get a list of the program transformations available in LLVM.<br>
   <dd><tt>opt</tt> can also be used to run a specific analysis on an input 
   LLVM bitcode file and print out the results.  It is primarily useful for 
   debugging analyses, or familiarizing yourself with what an analysis does.</dd>
@@ -1498,7 +1477,7 @@ are code generators for parts of LLVM infrastructure.</p>
 
 <div class="doc_text">
 <p>This section gives an example of using LLVM.  llvm-gcc3 is now obsolete,
-so we only include instructiosn for llvm-gcc4.
+so we only include instructions for llvm-gcc4.
 </p>
 
 <p><b>Note:</b> The <i>gcc4</i> frontend's invocation is <b><i>considerably different</i></b>
@@ -1636,9 +1615,9 @@ out:</p>
 <hr>
 <address>
   <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
-  src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
+  src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a>
   <a href="http://validator.w3.org/check/referer"><img
-  src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!" /></a>
+  src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a>
 
   <a href="mailto:sabre@nondot.org">Chris Lattner</a><br>
   <a href="http://llvm.x10sys.com/rspencer/">Reid Spencer</a><br>