When extracting SEME regions of code, the extractor needs to update the dominator...
[oota-llvm.git] / docs / GettingStarted.html
index 87a143fd0ec25a1390c8b0732dd6f3fcd61c4630..e740a89b01d07baa8ec3607179595ebacb7697d9 100644 (file)
@@ -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
@@ -214,11 +215,21 @@ software you will need.</p>
   <th>Arch</th>
   <th>Compilers</th>
 </tr>
+<tr>
+  <td>AuroraUX</td>
+  <td>x86<sup><a href="#pf_1">1</a></sup></td>
+  <td>GCC</td>
+</tr>
 <tr>
   <td>Linux</td>
   <td>x86<sup><a href="#pf_1">1</a></sup></td>
   <td>GCC</td>
 </tr>
+<tr>
+  <td>Linux</td>
+  <td>amd64</td>
+  <td>GCC</td>
+</tr>
 <tr>
   <td>Solaris</td>
   <td>V9 (Ultrasparc)</td>
@@ -238,7 +249,6 @@ software you will need.</p>
   <td>MacOS X<sup><a href="#pf_2">2</a>,<a href="#pf_9">9</a></sup></td>
   <td>x86</td>
   <td>GCC</td>
-
 </tr>
 <tr>
   <td>Cygwin/Win32</td>
@@ -247,14 +257,10 @@ software you will need.</p>
 </tr>
 <tr>
   <td>MinGW/Win32</td>
-  <td>x86<sup><a href="#pf_1">1</a>,<a href="#pf_6">6</a>,<a href="#pf_8">8</a></sup></td>
+  <td>x86<sup><a href="#pf_1">1</a>,<a href="#pf_6">6</a>,
+     <a href="#pf_8">8</a>, <a href="#pf_10">10</a></sup></td>
   <td>GCC 3.4.X, binutils 2.15</td>
 </tr>
-<tr>
-  <td>Linux</td>
-  <td>amd64</td>
-  <td>GCC</td>
-</tr>
 </table>
 
 <p>LLVM has partial support for the following platforms:</p>
@@ -320,15 +326,20 @@ up</a></li>
     levels greater than 0 (i.e., <i>"-O1"</i> and higher).
     Add <i>OPTIMIZE_OPTION="-O0"</i> to the build command line
     if compiling for LLVM Release or bootstrapping the LLVM toolchain.</li>
+<li><a name="pf_10">For MSYS/MinGW on Windows, be sure to install the MSYS
+    version of the perl package, and be sure it appears in your path
+    before any Windows-based versions such as Strawberry Perl and
+    ActivePerl, as these have Windows-specifics that will cause the
+    build to fail.</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 (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
@@ -544,7 +555,12 @@ 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 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>GCC 4.3.3 (Debian 4.3.3-10) on ARM</b>: Miscompiles parts of LLVM 2.6
+when optimizations are turned on. The symptom is an infinite loop in
+FoldingSetImpl::RemoveNode while running the code generator.
 <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
 defined in a discarded section. You can safely ignore these messages as they are
@@ -686,7 +702,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>
@@ -707,6 +723,7 @@ revision), you can checkout it from the '<tt>tags</tt>' directory (instead of
 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>
@@ -847,9 +864,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>
@@ -917,10 +936,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
@@ -930,6 +951,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
@@ -1006,6 +1028,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>