For PR814:
[oota-llvm.git] / docs / CFEBuildInstrs.html
index ffec81050481be4c95f5b3edca3fd036b3fb47e6..fa49c29e0b8cfd6ac38c69d8bd6e532acc39e378 100644 (file)
@@ -19,7 +19,8 @@
       <li><a href="#aix">Building under AIX</a></li>
     </ul>
   </li>
-  <li><a href="#instructions">Instructions</a></li>
+  <li><a href="#instructions">llvm-gcc4 Instructions</a></li>
+  <li><a href="#llvm-gcc3-instructions">llvm-gcc3 Instructions</a></li>
   <li><a href="#license">License Information</a></li>
 </ol>
 
 
 <div class="doc_text">
 <p>This document is intended to explain the process of building the
-LLVM C/C++ front-end, based on GCC 3.4, from its source code. You
-would have to do this, for example, if you are porting LLVM to a new
-architecture or operating system.</p>
+LLVM C/C++ front-end from its source code. You have to do this, for example, if
+you are porting LLVM to a new architecture or operating system, if you are
+working from Top-Of-Tree CVS/SVN, or if there is no precompiled snapshot
+available.</p>
 
 <p><b>NOTE:</b> This is currently a somewhat fragile, error-prone
 process, and you should <b>only</b> try to do it if:</p>
@@ -68,9 +70,11 @@ located in a top-level directory (like <tt>/cygdrive/c/llvm</tt> and
 and Settings" directory).  We welcome patches to fix this issue.
 </p>
 <p>It has been found that the GCC 3.3.3 compiler provided with recent Cygwin
-versions is incapable of compiling the LLVM CFE correctly. If your Cygwin
+versions is incapable of compiling the LLVM GCC front-end correctly. If your
+Cygwin
 installation includes GCC 3.3.3, we <i>strongly</i> recommend that you download
-GCC 3.4.3, build it separately, and use it for compiling LLVM CFE. This has been
+GCC 3.4.3, build it separately, and use it for compiling the LLVM GCC front-end.
+ This has been
 shown to work correctly.</p>
 <p>Some versions of Cygwin utilize an experimental version of GNU binutils that
 will cause the GNU <tt>ld</tt> linker to fail an assertion when linking
@@ -93,17 +97,57 @@ invalid code.  Instead, use the system assembler and linker.
 
 <!-- *********************************************************************** -->
 <div class="doc_section">
-  <a name="instructions">Instructions</a>
+  <a name="instructions">llvm-gcc4 Instructions</a>
 </div>
 <!-- *********************************************************************** -->
 
 <div class="doc_text">
-<p>
+
+<p>This section describes how to aquire and build llvm-gcc4, which is based on
+the GCC 4.0.1 front-end.  This front-end supports C, C++, Objective-C, and 
+Objective-C++.  Note that the instructions for building this front-end are
+completely different than those for building llvm-gcc3.
+</p>
+
 <ol>
+<li>
+<p>Retrieve the appropriate llvm-gcc4-x.y.source.tar.gz archive from the llvm
+web site.</p>
+<p>It is also possible to download the sources of the llvm-gcc4 front end from
+a read-only mirror using subversion.  To check out the code the first time use:
+</p>
+
+<tt>svn co svn://anonsvn.opensource.apple.com/svn/llvm <i>dst-directory</i></tt>
+
+<p>After that, the code can be be updated in the destination directory using;
+</p>
+
+<tt>svn update</tt>
+
+<p>The mirror is brought up to date every evening.</p>
+</li>
+
+<li>Follow the directions in the top-level README.LLVM file for up-to-date
+    instructions on how to build llvm-gcc4.</li>
+</ol>
+</div>
+
+<!-- *********************************************************************** -->
+<div class="doc_section">
+  <a name="llvm-gcc3-instructions">llvm-gcc3 Instructions</a>
+</div>
+<!-- *********************************************************************** -->
+
+<div class="doc_text">
+<ol>
+<li>Aquire llvm-gcc3 from <a href="GettingStarted.html#checkout">LLVM CVS</a> or
+from a <a href="http://llvm.org/releases/">release tarball</a>.</li>
+
 <li><p>Configure and build the LLVM libraries and tools. There are two ways to
 do this: either with <i>objdir</i> == <i>srcdir</i> or
 <i>objdir</i> != <i>srcdir</i>. It is recommended 
-that <i>srcdir</i> not be the same as <i>objdir</i>:</p>
+that <i>srcdir</i> be the same as <i>objdir</i> for your LLVM tree (but note
+that you should always use <i>srcdir</i> != <i>objdir</i> for llvm-gcc):</p>
 <ul>
   <li>With <i>objdir</i> != <i>srcdir</i>:<pre>
  % cd <i>objdir</i>
@@ -129,7 +173,7 @@ of permissions. Specify a path into which LLVM can be installed (e.g.
 </pre></li>
 
 <li><p>Unpack the C/C++ front-end source into cfrontend/src, either by
-       untar'ing an llvm-gcc.tar.gz file or checking out CVS into this
+       untar'ing a cfrontend.source.tar.gz file or checking out CVS into this
        directory.</p></li>
 
 <li><p>Make "build" and "install" directories as siblings of the "src" tree:</p>
@@ -146,6 +190,7 @@ of permissions. Specify a path into which LLVM can be installed (e.g.
 
 <p>
 <b>Linux/x86:</b><br>
+<b>Linux/IA-64:</b><br>
 <b>MacOS X/PowerPC</b> (requires dlcompat library):<br>
 <b>AIX/PowerPC:</b>
 </p>
@@ -176,18 +221,18 @@ macros defined for conditional compilation.
 </p>
 
 <p>
-The SPARC V8 backend is still beta quality software.  Unless you are working on
-the SPARC V8 backend, you should specify sparcv9 on the configure command line,
-as shown below. Also,
+The SPARC V8 ABI support is more robust than the V9 ABI support and can generate
+SPARC V9 code.  It is highly recommended that you use the V8 ABI with LLVM, as
+shown below.  Also,
 note that Solaris has trouble with various wide (multibyte) character
 functions from C as referenced from C++, so we typically configure with
---disable-c-mbchar (cf. <a href="http://llvm.cs.uiuc.edu/PR206">Bug 206</a>).
+--disable-c-mbchar (cf. <a href="http://llvm.org/PR206">Bug 206</a>).
 </p>
 
 <pre>
  % cd build
  % ../src/configure --prefix=$CFEINSTALL --disable-threads --disable-nls \
-   --disable-shared --enable-languages=c,c++ --host=sparcv9-sun-solaris2.8 \
+   --disable-shared --enable-languages=c,c++ --host=sparc-sun-solaris2.8 \
    --disable-c-mbchar --program-prefix=llvm-
  % gmake all; gmake install
 </pre>
@@ -295,51 +340,8 @@ COPYING.LIB for more details.
 </p>
 
 <p>
-The software also has the following additional copyrights:
+More information is <a href="FAQ.html#license">available in the FAQ</a>.
 </p>
-
-<pre>
-
-Copyright (c) 2003, 2004, 2005 University of Illinois at Urbana-Champaign.
-All rights reserved.
-
-Developed by:
-
-    LLVM Team
-
-    University of Illinois at Urbana-Champaign
-
-    http://llvm.cs.uiuc.edu
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
-FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
-CONTRIBUTORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS WITH THE
-SOFTWARE.
-
-Copyright (c) 1994
-Hewlett-Packard Company
-
-Permission to use, copy, modify, distribute and sell this software
-and its documentation for any purpose is hereby granted without fee,
-provided that the above copyright notice appear in all copies and
-that both that copyright notice and this permission notice appear
-in supporting documentation.  Hewlett-Packard Company makes no
-representations about the suitability of this software for any
-purpose.  It is provided "as is" without express or implied warranty.
-
-Copyright (c) 1996, 1997, 1998, 1999
-Silicon Graphics Computer Systems, Inc.
-
-Permission to use, copy, modify, distribute and sell this software
-and its documentation for any purpose is hereby granted without fee,
-provided that the above copyright notice appear in all copies and
-that both that copyright notice and this permission notice appear
-in supporting documentation.  Silicon Graphics makes no
-representations about the suitability of this software for any
-purpose.  It is provided "as is" without express or implied warranty.
 </pre>
 </div>
 
@@ -353,7 +355,7 @@ purpose.  It is provided "as is" without express or implied warranty.
   src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!"></a>
 
   Brian Gaeke<br>
-  <a href="http://llvm.cs.uiuc.edu">LLVM Compiler Infrastructure</a><br>
+  <a href="http://llvm.org">LLVM Compiler Infrastructure</a><br>
   Last modified: $Date$
 </address>