[project @ 2003-06-02 08:52:28 by simonmar]
[ghc-hetmet.git] / docs / building / building.sgml
index f7d3217..30353c5 100644 (file)
@@ -456,6 +456,10 @@ setsockopt IPTOS_THROUGHPUT: Invalid argument
           <literal>hslibs</literal> and <literal>libraries</literal>
           modules (for a full list of the projects available, see
           <xref linkend="projects">).</para>
+
+         <para>Remember that if you do not have
+          <literal>happy</literal> installed, you need to check it out
+          as well.</para>
        </listitem>
       </itemizedlist>
     </sect2>
@@ -491,7 +495,14 @@ $ cvs diff
           you the results.</para>
        </listitem>
 
-      <listitem>
+       <listitem>
+         <para>If you changed something in the 
+          <literal>fptools/libraries</literal> subdirectories, also run
+          <literal>make html</literal> to check if the documentation can
+          be generated successfully, too.</para>
+       </listitem>
+
+       <listitem>
          <para>Before checking in a change, you need to update your
           source tree:</para>
 
@@ -574,17 +585,25 @@ $ cvs commit -F <replaceable>commit-message</replaceable> <replaceable>directory
       major cause of headaches. </para>
 
       <para>So, to avoid a lot of hassle, follow this recipe for
-      updating your tree: </para>
+      updating your tree:</para>
 
 <screen>
 $ cd fptools
-$ cvs update -Pd 2&gt;&amp;1 | tee log</screen>
+$ cvs update -P 2&gt;&amp;1 | tee log</screen>
 
       <para>Look at the log file, and fix any conflicts (denoted by a
-      <quote>C</quote> in the first column). If you're using multiple
-      build trees, then for every build tree you have pointing at this
-      source tree, you need to update the links in case any new files
-      have appeared: </para>
+      <quote>C</quote> in the first column).  New directories may have
+      appeared in the repository; CVS doesn't check these out by
+      default, so to get new directories you have to explicitly do
+<screen>
+$ cvs update -d</screen>
+      in each project subdirectory.  Don't do this at the top level,
+      because then <emphasis>all</emphasis> the projects will be
+      checked out.</para>
+
+      <para>If you're using multiple build trees, then for every build
+      tree you have pointing at this source tree, you need to update
+      the links in case any new files have appeared: </para>
 
 <screen>
 $ cd <replaceable>build-tree</replaceable>
@@ -1205,6 +1224,12 @@ $ cvs checkout nofib/spectral
           <command>egcs</command>) have varying degrees of stability
           depending on the platform.</para>
 
+         <para>GCC 3.2 is currently known to have problems building
+         GHC on Sparc, but is stable on x86.</para>
+         
+         <para>GCC 3.3 currently cannot be used to build GHC, due to
+         some problems with the new C preprocessor.</para>
+
          <para>If your GCC dies with &ldquo;internal error&rdquo; on
           some GHC source file, please let us know, so we can report
           it and get things improved.  (Exception: on iX86
@@ -1236,7 +1261,7 @@ $ cvs checkout nofib/spectral
           (<literal>fptools/happy</literal>).  It can be built from
           source, but bear in mind that you'll need GHC installed in
           order to build it.  To avoid the chicken/egg problem,
-          install a binary distribtion of either Happy or GHC to get
+          install a binary distribution of either Happy or GHC to get
           started.  Happy distributions are available from <ulink
           url="http://www.haskell.org/happy/">Happy's Web
           Page</ulink>.</para>
@@ -1252,6 +1277,10 @@ $ cvs checkout nofib/spectral
           CVS sources, it is <emphasis>not</emphasis> needed if you
           just intend to build a standard source distribution.</para>
 
+         <para>Version 2.52 or later of autoconf is required.
+         NB. vesrion 2.13 will no longer work, as of GHC version
+         6.1.</para>
+
          <para>Autoconf builds the <command>configure</command>
           script from <filename>configure.in</filename> and
           <filename>aclocal.m4</filename>.  If you modify either of
@@ -1293,7 +1322,7 @@ $ cvs checkout nofib/spectral
          <listitem>
            <para>PVM is the Parallel Virtual Machine on which
             Parallel Haskell programs run.  (You only need this if you
-            plan to run Parallel Haskell.  Concurent Haskell, which
+            plan to run Parallel Haskell.  Concurrent Haskell, which
             runs concurrent threads on a uniprocessor doesn't need
             it.)  Underneath PVM, you can have (for example) a network
             of workstations (slow) or a multiprocessor box
@@ -2210,7 +2239,7 @@ Foo.o : Baz.hi
 
       <para> Do <emphasis>NOT</emphasis> use
       <filename>ghc/compiler/ghc</filename>, or
-      <filename>ghc/compiler/ghc-5.xx</filename>, as these are the
+      <filename>ghc/compiler/ghc-6.xx</filename>, as these are the
       scripts intended for installation, and contain hard-wired paths
       to the installed libraries, rather than the libraries in the
       build tree.</para>
@@ -3596,10 +3625,10 @@ $ make install-docs
       target machine, and compiling them using gcc to get a working
       GHC.</para>
 
-      <para><emphasis>NOTE: GHC version 5.xx is significantly harder
-      to bootstrap from C than previous versions.  We recommend
-      starting from version 4.08.2 if you need to bootstrap in this
-      way.</emphasis></para>
+      <para><emphasis>NOTE: GHC versions 5.xx and later are
+      significantly harder to bootstrap from C than earlier versions.
+      We recommend starting from version 4.08.2 if you need to
+      bootstrap in this way.</emphasis></para>
 
       <para>HC files are architecture-dependent (but not
       OS-dependent), so you have to get a set that were generated on
@@ -3721,11 +3750,11 @@ GhcWithRegisterised=NO
 </programlisting>
 
 <programlisting>
-# build.mk for GHC 5.xx
+# build.mk for GHC 5.xx and 6.x
 GhcUnregisterised=YES
 </programlisting>
 
-       <para>Version 5.xx only: use the option
+       <para>Versions 5.xx and 6.x only: use the option
        <option>--enable-hc-boot-unregisterised</option> instead of
        <option>--enable-hc-boot</option> when running
        <filename>./configure</filename>.</para>