X-Git-Url: http://git.megacz.com/?a=blobdiff_plain;f=docs%2Fbuilding%2Fbuilding.xml;h=2b448fabaa0714535f6004e5085c70ec5b719485;hb=523d16b79ef458ee7a3c9d19896e08d36c2dcbb6;hp=ae22c81d286733017018997588e925bdbe67190f;hpb=1013f2bbde5eb3e8bba4da6d851215963a93b239;p=ghc-hetmet.git

diff --git a/docs/building/building.xml b/docs/building/building.xml
index ae22c81..2b448fa 100644
--- a/docs/building/building.xml
+++ b/docs/building/building.xml
@@ -407,12 +407,12 @@ setsockopt IPTOS_THROUGHPUT: Invalid argument</screen>
           result in checking out the entire repository instead of just
           the <literal>fpconfig</literal> bit.</para>
 <screen>$ cd <replaceable>directory</replaceable>
-$ cvs checkout ghc hslibs libraries</screen>
+$ cvs checkout ghc libraries</screen>
 
 	  <para>The second command here checks out the relevant
           modules you want to work on. For a GHC build, for instance,
           you need at least the <literal>ghc</literal>,
-          <literal>hslibs</literal> and <literal>libraries</literal>
+          and <literal>libraries</literal>
           modules (for a full list of the projects available, see
           <xref linkend="projects"/>).</para>
 
@@ -605,7 +605,7 @@ $ lndir <replaceable>source-tree</replaceable></screen>
 
 <screen>$ cvs co -r ghc-4-06 fpconfig
 $ cd fptools
-$ cvs co -r ghc-4-06 ghc hslibs</screen>
+$ cvs co -r ghc-4-06 ghc libraries</screen>
     </sect2>
 
     <sect2 id="cvs-hints">
@@ -793,8 +793,7 @@ $ cvs checkout nofib/spectral</screen>
           <indexterm><primary><literal>hslibs</literal></primary><secondary>project</secondary></indexterm>
         </term>
 	<listitem>
-	  <para>Supplemental libraries for GHC
-	  (<emphasis>required</emphasis> for building GHC).</para>
+	  <para>Old, now deprecated, libraries.  Everything in here is in <literal>libraries</literal>.
 	</listitem>
       </varlistentry>
 
@@ -843,8 +842,8 @@ $ cvs checkout nofib/spectral</screen>
     </variablelist>
 
     <para>So, to build GHC you need at least the
-    <literal>ghc</literal>, <literal>libraries</literal> and
-    <literal>hslibs</literal> projects (a GHC source distribution will
+    <literal>ghc</literal> and <literal>libraries</literal>
+    projects (a GHC source distribution will
     already include the bits you need).</para>
   </sect1>
 
@@ -2952,6 +2951,58 @@ directive.
       ones in <filename>boilerplate.mk</filename>.</para>
     </sect2>
 
+    <sect2 id="sec-platforms">
+      <title>Platform settings</title>
+      <indexterm><primary>Platform settings</primary>
+      </indexterm>
+
+      <para>There are three platforms of interest when building GHC:</para>
+      
+      <variablelist>
+	<varlistentry>
+	  <term>The <emphasis>build</emphasis> platform</term>
+	  <listitem>
+	    <para>The platform on which we are doing this build.</para>
+	  </listitem>
+	</varlistentry>
+
+	<varlistentry>
+	  <term>The <emphasis>host</emphasis> platform</term>
+	  <listitem>
+	    <para>The platform on which these binaries will run.</para>
+	  </listitem>
+	</varlistentry>
+
+	<varlistentry>
+	  <term>The <emphasis>target</emphasis> platform</term>
+	  <listitem>
+	    <para>The platform for which this compiler will generate code.</para>
+	  </listitem>
+	</varlistentry>
+      </variablelist>
+      
+      <para>These platforms are set when running the
+	<literal>configure</literal> script, using the
+	<option>--build</option>, <option>--host</option>, and
+	<option>--target</option> options.  The <filename>mk/config.mk</filename>
+	file defines several symbols related to the platform settings (see
+	<filename>mk/config.mk</filename> for details).</para>
+
+      <para>We don't currently support build &amp; host being different, because
+	the build process creates binaries that are both run during the build,
+	and also installed.</para>
+
+      <para>If host and target are different, then we are building a
+	cross-compiler.  For GHC, this means a compiler
+	which will generate intermediate .hc files to port to the target
+	architecture for bootstrapping.  The libraries and stage 2 compiler
+	will be built as HC files for the target system (see <xref
+	  linkend="sec-porting-ghc" /> for details.</para>
+
+      <para>More details on when to use BUILD, HOST or TARGET can be found in
+	the comments in <filename>config.mk</filename>.</para>
+    </sect2>
+
     <sect2 id="sec-suffix">
       <title>Pattern rules and options</title>
       <indexterm><primary>Pattern rules</primary></indexterm>
@@ -3566,7 +3617,7 @@ $ make install</screen>
           corresponding Haskell source (<filename>.hs</filename> or
           <filename>.lhs</filename>) in the compiler subdirectory
           <filename>ghc/compiler</filename> and in the libraries
-          (subdirectories of <filename>hslibs</filename> and
+          (subdirectories of 
           <literal>libraries</literal>).</para>
 	</listitem>
 
@@ -3695,7 +3746,7 @@ $ ./configure --enable-hc-boot --enable-hc-boot-unregisterised</screen>
   
 	    <listitem>
 <screen>$ cd <replaceable>T</replaceable>/ghc/includes
-$ make ghcconfig.h</screen>
+$ make</screen>
 	    </listitem>
 	  </itemizedlist>
 	  </listitem>
@@ -3726,7 +3777,7 @@ GhcLibWays =
 SplitObjs = NO
 GhcWithNativeCodeGen = NO
 GhcWithInterpreter = NO
-GhcStage1HcOpts = -O -fasm
+GhcStage1HcOpts = -O
 GhcStage2HcOpts = -O -fvia-C -keep-hc-files
 SRC_HC_OPTS += -H32m
 GhcBootLibs = YES</programlisting>
@@ -3755,20 +3806,19 @@ GhcBootLibs = YES</programlisting>
 
 	    <listitem>
 	      <para>Copy
-	      <filename><replaceable>T</replaceable>/ghc/includes/ghcconfig.h</filename>
+	      <filename><replaceable>T</replaceable>/ghc/includes/ghcautoconf.h</filename>, <filename><replaceable>T</replaceable>/ghc/includes/DerivedConstants.h</filename>, and <filename><replaceable>T</replaceable>/ghc/includes/GHCConstants.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
+	      target machine's configuration files.  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>ghcconfig.h</literal>, just to make
-		sure it doesn't get replaced during the build:</para>
-<screen>$ touch <replaceable>H</replaceable>/ghc/includes/ghcconfig.h</screen>
+		<para>Touch the generated configuration files, just to make
+		sure they don't get replaced during the build:</para>
+<screen>$ touch <filename><replaceable>H</replaceable></filename>/ghc/includes/{ghcautoconf.h,DerivedConstants.h.GHCConstants.h.mkDerivedConstants.c,mkDerivedConstantsHdr,mkDerivedConstants.o,mkGHCConstants,mkGHCConstants.o}</screen>
 	      </listitem>
 
 	    <listitem>
@@ -4766,6 +4816,11 @@ so you will need to add <filename>emacs/bin</filename> to your <literal>PATH</li
 </para>
 </listitem>
 
+	  <listitem>
+	    <para>You might want to install GLUT in your MSYS/Cygwin
+	      installation, otherwise the GLUT package will not be built with
+	      GHC.</para>
+	  </listitem>
 
 <listitem>
 <para> Finally, check out a copy of GHC sources from