Fix the 3 regressions last night, due to my buggy patch from yesterday.
[oota-llvm.git] / docs / CFEBuildInstrs.html
index 658330a86f349954bc57acf2fc1b1ee5417d7f0d..f9f4bf29b5f9f0d019b5aac6ab9f3d5f03ab7a42 100644 (file)
@@ -46,6 +46,7 @@ process, and you should <b>only</b> try to do it if:</p>
 <ol>
   <li>you really, really, really can't use the binaries we distribute</li>
   <li>you are an elite GCC hacker.</li>
+  <li>you want to use the latest bits from CVS.</li>
 </ol>
 
 <p>We welcome patches to help make this process simpler.</p>
@@ -66,14 +67,23 @@ located in a top-level directory (like <tt>/cygdrive/c/llvm</tt> and
 (which includes your "home directory", because it lives under the "Documents 
 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
+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
+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
+components of the libstdc++. It is recommended that you replace the entire
+binutils package with version 2.15 such that "<tt>ld --version</tt>" responds
+with</p>
+<pre>GNU ld version 2.15</pre>
+not with:<br/>
+<pre>GNU ld version 2.15.91 20040725</pre>
 </div>
 
 <!--=========================================================================-->
-<div class="doc_subsection">
-  <a name="aix">Building under AIX</a>
-</div>
-<!--=========================================================================-->
-
+<div class="doc_subsection"><a name="aix">Building under AIX</a></div>
 <div class="doc_text">
 <p>If you are building LLVM and the GCC front-end under AIX, do NOT use GNU
 Binutils.  They are not stable under AIX and may produce incorrect and/or
@@ -90,17 +100,26 @@ invalid code.  Instead, use the system assembler and linker.
 <div class="doc_text">
 <p>
 <ol>
-<li><p>Configure and build the LLVM libraries and tools using:</p>
-<pre>
+<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 not. It is recommended 
+that <i>srcdir</i> not be the same as <i>objdir</i>:</p>
+<ul>
+  <li>With <i>objdir</i> != <i>srcdir</i>:<pre>
+ % cd <i>objdir</i>
+ % <i>srcdir</i>/configure --prefix=/some/path/you/can/install/to [options...]
+ % gmake tools-only
+  </pre></li>
+  <li>With <i>objdir</i> == <i>srcdir</i>:<pre>
  % cd llvm
  % ./configure --prefix=/some/path/you/can/install/to [options...]
  % gmake tools-only
-</pre>
-  <p>This will build all of the LLVM tools and libraries. The <tt>--prefix</tt> 
-  option defaults to /usr/local (per configure standards) but unless you are a 
-  system administrator, you probably won't be able to install LLVM there because
-  of permissions. Specify a path into which LLVM can be installed (e.g.
-  <tt>--prefix=/home/user/llvm</tt>).</p>
+  </pre></li>
+</ul>
+<p>This will build all of the LLVM tools and libraries. The <tt>--prefix</tt> 
+option defaults to /usr/local (per configure standards) but unless you are a 
+system administrator, you probably won't be able to install LLVM there because
+of permissions. Specify a path into which LLVM can be installed (e.g.
+<tt>--prefix=/home/user/llvm</tt>).</p>
 </li>
 
 <li><p>Add the directory containing the tools to your PATH.</p>
@@ -108,7 +127,9 @@ invalid code.  Instead, use the system assembler and linker.
  % set path = ( `cd llvm/Debug/bin &amp;&amp; pwd` $path )
 </pre></li>
 
-<li><p>Unpack the C/C++ front-end source into cfrontend/src.</p></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
+       directory.</p></li>
 
 <li><p>Make "build" and "install" directories as siblings of the "src" tree.</p>
 <pre>
@@ -213,7 +234,6 @@ variable.</p>
   <ul>
     <li>sh: <tt>export PATH=$CFEINSTALL/bin:$PATH</tt></li>
     <li>csh: <tt>setenv PATH $CFEINSTALL/bin:$PATH</tt></li>
-    <li>win: <tt>set PATH=$CFEINSTALL/bin;$PATH</tt></li>
   </ul>
 </li>
 
@@ -221,21 +241,12 @@ variable.</p>
 the same options as the last time. This will cause the configuration to now find
 the newly built llvm-gcc and llvm-g++ executables. </p></li>
 
-<li><p>If you edited header files during the C/C++ front-end build as
-described in "Fix 1" above, you must now copy those header files from
-<code>$CFEINSTALL/<i>target-triplet</i>/sys-include</code> to
-<code>$CFEINSTALL/lib/gcc/<i>target-triplet</i>/3.4-llvm/include</code>.
-(This should be the "include" directory in the same directory as the
-libgcc.a library, which you can find by running
-<code>$CFEINSTALL/bin/llvm-gcc --print-libgcc-file-name</code>.)</p></li>
-
 <li><p>Rebuild your CVS tree.  This shouldn't cause the whole thing to be
   rebuilt, but it should build the runtime libraries.  After the tree is
   built, install the runtime libraries into your GCC front-end build tree.
-  These are the commands you need.</p>
+  These are the commands you need:</p>
 <pre>
  % gmake
- % mkdir $CFEINSTALL/lib
  % gmake -C runtime install-bytecode
 </pre></li>
 
@@ -248,7 +259,7 @@ link times. Use the <tt>llvm-ranlib</tt> tool to do this, as follows:</p>
  % llvm-ranlib libiberty.a
  % llvm-ranlib libstdc++.a
  % llvm-ranlib libsupc++.a
- % cd $CFEINSTALL/lib/<i>target-triplet</i>/3.4-llvm
+ % cd $CFEINSTALL/lib/gcc/<i>target-triplet</i>/3.4-llvm
  % llvm-ranlib libgcc.a
  % llvm-ranlib libgcov.a
 </pre>