Update the Ada instructions to LLVM 2.7 (from LLVM 2.5).
[oota-llvm.git] / docs / GCCFEBuildInstrs.html
index a36fb375601a04796685bc2c12ce3d21ec5675db..8fe0c31cb64e283a3b85f0ef03d3cf35c1871490 100644 (file)
@@ -14,6 +14,8 @@
 
 <ol>
   <li><a href="#instructions">Building llvm-gcc from Source</a></li>
+  <li><a href="#ada">Building the Ada front-end</a></li>
+  <li><a href="#fortran">Building the Fortran front-end</a></li>
   <li><a href="#license">License Information</a></li>
 </ol>
 
@@ -22,9 +24,7 @@
 </div>
 
 <!-- *********************************************************************** -->
-<div class="doc_section">
-  <a name="instructions">Building llvm-gcc from Source</a>
-</div>
+<h1><a name="instructions">Building llvm-gcc from Source</a></h1>
 <!-- *********************************************************************** -->
 
 <div class="doc_text">
@@ -36,8 +36,9 @@ front-ends are completely different (and much easier!) than those for building
 llvm-gcc3 in the past.</p>
 
 <ol>
-  <li><p>Retrieve the appropriate llvm-gcc-4.2-x.y.source.tar.gz archive from the
-         <a href="http://llvm.org/releases/">llvm web site</a>.</p>
+  <li><p>Retrieve the appropriate llvm-gcc-4.2-<i>version</i>.source.tar.gz
+         archive from the <a href="http://llvm.org/releases/">LLVM web
+         site</a>.</p>
 
       <p>It is also possible to download the sources of the llvm-gcc front end
          from a read-only mirror using subversion.  To check out the 4.2 code
@@ -66,9 +67,8 @@ svn co http://llvm.org/svn/llvm-project/llvm-gcc-4.2/trunk <i>dst-directory</i>
 </div>
 
 <!-- *********************************************************************** -->
-<div class="doc_section">
-  <a name="license">Building the Ada front-end</a>
-</div>
+<h1><a name="ada">Building the Ada front-end</a></h1>
+<!-- *********************************************************************** -->
 
 <div class="doc_text">
 <p>Building with support for Ada amounts to following the directions in the
@@ -84,10 +84,11 @@ top-level <tt>README.LLVM</tt> file, adding ",ada" to EXTRALANGS, for example:
   <li><p>The build requires having a compiler that supports Ada, C and C++.
       The Ada front-end is written in Ada so an Ada compiler is needed to
       build it.  Compilers known to work with the
-      <a href="http://llvm.org/releases/download.html">LLVM 2.4 release</a>
+      <a href="http://llvm.org/releases/download.html">LLVM 2.7 release</a>
       are <a href="http://gcc.gnu.org/releases.html">gcc-4.2</a> and the
       2005, 2006 and 2007 versions of the
       <a href="http://libre.adacore.com/">GNAT GPL Edition</a>.
+      <b>GNAT GPL 2008, gcc-4.3 and later will not work</b>.
       The LLVM parts of llvm-gcc are written in C++ so a C++ compiler is
       needed to build them.  The rest of gcc is written in C.
       Some linux distributions provide a version of gcc that supports all
@@ -100,6 +101,11 @@ top-level <tt>README.LLVM</tt> file, adding ",ada" to EXTRALANGS, for example:
       compiler with checking enabled.  This causes it to run much slower, but
       helps catch mistakes in the compiler (please report any problems using
       <a href="http://llvm.org/bugs">LLVM bugzilla</a>).</p></li>
+  <li><p>The Ada front-end <a href="http://llvm.org/PR2007">fails to
+      bootstrap</a>, due to lack of LLVM support for
+      <tt>setjmp</tt>/<tt>longjmp</tt> style exception handling (used
+      internally by the compiler), so you must specify
+      <tt>--disable-bootstrap</tt>.</p></li>
 </ol>
 
 <p>Supposing appropriate compilers are available, llvm-gcc with Ada support can
@@ -109,140 +115,140 @@ top-level <tt>README.LLVM</tt> file, adding ",ada" to EXTRALANGS, for example:
   <li><p>Download the <a href="http://llvm.org/releases/download.html">LLVM source</a>
       and unpack it:</p>
 
-<div class="doc_code">
-<pre>wget http://llvm.org/releases/2.4/llvm-2.4.tar.gz
-tar xzf llvm-2.4.tar.gz
-mv llvm-2.4 llvm</pre>
-</div>
+<pre class="doc_code">
+wget http://llvm.org/releases/2.7/llvm-2.7.tgz
+tar xzf llvm-2.7.tgz
+mv llvm-2.7 llvm
+</pre>
 
       <p>or <a href="GettingStarted.html#checkout">check out the
       latest version from subversion</a>:</p>
 
-<div class="doc_code">
-<pre>svn co http://llvm.org/svn/llvm-project/llvm/trunk llvm</pre>
-</div>
+<pre class="doc_code">svn co http://llvm.org/svn/llvm-project/llvm/trunk llvm</pre>
+
       </li>
 
   <li><p>Download the
       <a href="http://llvm.org/releases/download.html">llvm-gcc-4.2 source</a>
       and unpack it:</p>
 
-<div class="doc_code">
-<pre>wget http://llvm.org/releases/2.4/llvm-gcc-4.2-2.4.source.tar.gz
-tar xzf llvm-gcc-4.2-2.4.source.tar.gz
-mv llvm-gcc4.2-2.4.source llvm-gcc-4.2</pre>
-</div>
+<pre class="doc_code">
+wget http://llvm.org/releases/2.7/llvm-gcc-4.2-2.7.source.tgz
+tar xzf llvm-gcc-4.2-2.7.source.tgz
+mv llvm-gcc-4.2-2.7.source llvm-gcc-4.2
+</pre>
 
       <p>or <a href="GettingStarted.html#checkout">check out the
       latest version from subversion</a>:</p>
 
-<div class="doc_code">
-<pre>svn co http://llvm.org/svn/llvm-project/llvm-gcc-4.2/trunk llvm-gcc-4.2</pre>
-</div>
+<pre class="doc_code">
+svn co http://llvm.org/svn/llvm-project/llvm-gcc-4.2/trunk llvm-gcc-4.2
+</pre>
       </li>
 
   <li><p>Make a build directory <tt>llvm-objects</tt> for llvm and make it the
       current directory:</p>
 
-<div class="doc_code">
-<pre>mkdir llvm-objects
-cd llvm-objects</pre>
-</div>
+<pre class="doc_code">
+mkdir llvm-objects
+cd llvm-objects
+</pre>
       </li>
 
   <li><p>Configure LLVM (here it is configured to install into <tt>/usr/local</tt>):</p>
 
-<div class="doc_code">
-<pre>../llvm/configure --prefix=<b>/usr/local</b></pre>
-</div>
+<pre class="doc_code">
+../llvm/configure --prefix=<b>/usr/local</b> --enable-optimized --enable-assertions
+</pre>
 
       <p>If you have a multi-compiler setup and the C++ compiler is not the
       default, then you can configure like this:</p>
 
-<div class="doc_code">
-<pre>CXX=<b>PATH_TO_C++_COMPILER</b> ../llvm/configure --prefix=<b>/usr/local</b></pre>
-</div>
+<pre class="doc_code">
+CXX=<b>PATH_TO_C++_COMPILER</b> ../llvm/configure --prefix=<b>/usr/local</b> --enable-optimized --enable-assertions
+</pre>
+
+      <p>To compile without checking (not recommended), replace
+      <tt>--enable-assertions</tt> with <tt>--disable-assertions</tt>.</p>
+
       </li>
 
-  <li><p>Build LLVM with checking enabled (use <tt>ENABLE_OPTIMIZED=1</tt> to
-         build without checking):</p>
+  <li><p>Build LLVM:</p>
 
-<div class="doc_code">
-<pre>make ENABLE_OPTIMIZED=0</pre>
-</div>
+<pre class="doc_code">
+make
+</pre>
       </li>
 
   <li><p>Install LLVM (optional):</p>
 
-<div class="doc_code">
-<pre>make ENABLE_OPTIMIZED=0 install</pre>
-</div>
+<pre class="doc_code">
+make install
+</pre>
       </li>
 
   <li><p>Make a build directory <tt>llvm-gcc-4.2-objects</tt> for llvm-gcc and make it the
       current directory:</p>
 
-<div class="doc_code">
-<pre>
+<pre class="doc_code">
 cd ..
 mkdir llvm-gcc-4.2-objects
-cd llvm-gcc-4.2-objects</pre>
-</div>
+cd llvm-gcc-4.2-objects
+</pre>
       </li>
 
   <li><p>Configure llvm-gcc (here it is configured to install into <tt>/usr/local</tt>).
       The <tt>--enable-checking</tt> flag turns on sanity checks inside the compiler.
-      If you omit it then LLVM should be built with <tt>make ENABLE_OPTIMIZED=1</tt>.
-      Additional languages can be appended to the --enable-languages switch,
+      To turn off these checks (not recommended), replace <tt>--enable-checking</tt>
+      with <tt>--disable-checking</tt>.
+      Additional languages can be appended to the <tt>--enable-languages</tt> switch,
       for example <tt>--enable-languages=ada,c,c++</tt>.</p>
 
-<div class="doc_code">
-<pre>../llvm-gcc-4.2/configure --prefix=<b>/usr/local</b> --enable-languages=ada,c --enable-checking --enable-llvm=$PWD/../llvm-objects --disable-bootstrap --disable-multilib</pre>
-</div>
+<pre class="doc_code">
+../llvm-gcc-4.2/configure --prefix=<b>/usr/local</b> --enable-languages=ada,c \
+                          --enable-checking --enable-llvm=$PWD/../llvm-objects \
+                         --disable-bootstrap --disable-multilib
+</pre>
 
       <p>If you have a multi-compiler setup, then you can configure like this:</p>
-<div class="doc_code">
 
-<pre>
+<pre class="doc_code">
 export CC=<b>PATH_TO_C_AND_ADA_COMPILER</b>
 export CXX=<b>PATH_TO_C++_COMPILER</b>
-../llvm-gcc-4.2/configure --prefix=<b>/usr/local</b> --enable-languages=ada,c --enable-checking --enable-llvm=$PWD/../llvm-objects --disable-bootstrap --disable-multilib</pre>
-</div>
+../llvm-gcc-4.2/configure --prefix=<b>/usr/local</b> --enable-languages=ada,c \
+                          --enable-checking --enable-llvm=$PWD/../llvm-objects \
+                         --disable-bootstrap --disable-multilib
+</pre>
       </li>
 
   <li><p>Build and install the compiler:</p>
 
-<div class="doc_code">
-<pre>make
-make install</pre>
-</div>
+<pre class="doc_code">
+make
+make install
+</pre>
       </li>
 </ol>
 
 </div>
 
 <!-- *********************************************************************** -->
-<div class="doc_section">
-  <a name="license">Building the Fortran front-end</a>
-</div>
+<h1><a name="fortran">Building the Fortran front-end</a></h1>
+<!-- *********************************************************************** -->
 
 <div class="doc_text">
-<p>
-To build with support for Fortran, follow the directions in the top-level
+<p>To build with support for Fortran, follow the directions in the top-level
 <tt>README.LLVM</tt> file, adding ",fortran" to EXTRALANGS, for example:</p>
 
-<div class="doc_code">
-<pre>
+<pre class="doc_code">
 EXTRALANGS=,fortran
 </pre>
-</div>
 
 </div>
 
 <!-- *********************************************************************** -->
-<div class="doc_section">
-  <a name="license">License Information</a>
-</div>
+<h1><a name="license">License Information</a></h1>
+<!-- *********************************************************************** -->
 
 <div class="doc_text">
 <p>
@@ -261,9 +267,9 @@ More information is <a href="FAQ.html#license">available in the FAQ</a>.
 <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="http://llvm.org">LLVM Compiler Infrastructure</a><br>
   Last modified: $Date$