[project @ 2003-09-11 10:26:31 by simonmar]

[ghc-hetmet.git] / docs / building / building.sgml

diff --git a/docs/building/building.sgml b/docs/building/building.sgml
index f0adddd..4d25aa2 100644 (file)
--- a/docs/building/building.sgml
+++ b/docs/building/building.sgml
@@ -434,8 +434,8 @@ setsockopt IPTOS_THROUGHPUT: Invalid argument
           <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>
+          <literal>happy</literal> and/or <literal>Alex</literal>
+          installed, you need to check them out as well.</para>
        </listitem>
       </itemizedlist>
     </sect2>
@@ -1262,6 +1262,19 @@ $ cvs checkout nofib/spectral
       </varlistentry>
 
       <varlistentry>
+       <term>Alex</term>
+       <indexterm><primary>Alex</primary></indexterm>
+       <listitem>
+         <para>Alex is a lexical-analyser generator for Haskell,
+         which GHC uses to generate its lexer.  Like Happy, Alex is
+         written in Haskell and is a project in the CVS repository.
+         Alex distributions are available from <ulink
+         url="http://www.haskell.org/alex/">Alex's Web
+         Page</ulink>.</para>
+       </listitem>
+      </varlistentry>
+
+      <varlistentry>
        <term>Autoconf</term>
        <indexterm><primary>pre-supposed: Autoconf</primary></indexterm>
        <indexterm><primary>Autoconf, pre-supposed</primary></indexterm>
@@ -2238,7 +2251,8 @@ Foo.o : Baz.hi
       build tree.</para>
 
       <para>Happy can similarly be run from the build tree, using
-      <filename>happy/src/happy-inplace</filename>.</para>
+      <filename>happy/src/happy-inplace</filename>, and similarly for
+      Alex and Haddock.</para>
     </sect2>
 
     <sect2>
@@ -3756,6 +3770,7 @@ foo% make install
 
            <listitem>
 <screen>
+$ cd <replaceable>T</replaceable>
 $ ./configure --enable-hc-boot --enable-hc-boot-unregisterised
 </screen>
 
@@ -3809,17 +3824,6 @@ GhcStage2HcOpts = -O -fvia-C -keep-hc-files
            </listitem>
 
            <listitem>
-             <para>Copy
-             <filename><replaceable>T</replaceable>/ghc/includes/config.h</filename>
-             to
-             <filename><replaceable>H</replaceable>/ghc/includes</filename>.
-             Note that we are building on the host machine, using the
-             target machine's <literal>config.h</literal> file.  This
-             is so that the intermediate C files generated here will
-             be suitable for compiling on the target system.</para>
-           </listitem>
-
-           <listitem>
              <para>Edit
              <filename><replaceable>H</replaceable>/mk/config.mk</filename>:</para>
              <itemizedlist>
@@ -3835,16 +3839,30 @@ GhcStage2HcOpts = -O -fvia-C -keep-hc-files
            </listitem>
            
            <listitem>
-<screen>
-$ cd <replaceable>H</replaceable>/glafp-utils && make boot && make
-</screen>
+             <para>Copy
+             <filename><replaceable>T</replaceable>/ghc/includes/config.h</filename>
+             to
+             <filename><replaceable>H</replaceable>/ghc/includes</filename>.
+             Note that we are building on the host machine, using the
+             target machine's <literal>config.h</literal> file.  This
+             is so that the intermediate C files generated here will
+             be suitable for compiling on the target system.</para>
+
            </listitem>
-           
+
+             <listitem>
+               <para>Touch <literal>config.h</literal>, just to make
+               sure it doesn't get replaced during the build:</para>
+<screen>
+$ touch <replaceable>H</replaceable>/ghc/includes/config.h</screen>
+             </listitem>
+
            <listitem>
+               <para>Now build the compiler:</para>
 <screen>
+$ cd <replaceable>H</replaceable>/glafp-utils && make boot && make
 $ cd <replaceable>H</replaceable>/ghc && make boot && make
 </screen>
-
              <para>Don't worry if the build falls over in the RTS, we
               don't need the RTS yet.</para>
            </listitem>
@@ -4592,6 +4610,12 @@ Happy is a parser generator used to compile the Haskell grammar.  Add it in your
 </para>
 </listitem>
 
+         <listitem>
+           <para>Install Alex.  This can be done by building from the
+           source distribution in the usual way.  Sources are
+           available from <ulink
+           url="http://www.haskell.org/alex">http://www.haskell.org/alex</ulink>.</para>
+         </listitem>
 
 <listitem>
 <para>GHC uses the <emphasis>mingw</emphasis> C compiler to