</listitem>
<listitem>
<para>Set your <literal>$CVSROOT</literal> environment variable to
- <literal>:pserver:anoncvs@glass.cse.ogi.edu:/cvs</literal></para>
+ <literal>:pserver:anoncvs@cvs.haskell.org:/cvs</literal></para>
<para>If you set <literal>$CVSROOT</literal> in a shell script, be sure not to
have any trailing spaces on that line, otherwise CVS will respond with
a perplexing message like
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>
<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">
<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>.</para>
</listitem>
</varlistentry>
</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>
Perl version 5 at least is required. GHC has been known to
tickle bugs in Perl, so if you find that Perl crashes when
running GHC try updating (or downgrading) your Perl
- installation. Versions of Perl that we use and are known to
- be fairly stable are 5.005 and 5.6.1.</para>
+ installation. Versions of Perl before 5.6 have been known to have
+ various bugs tickled by GHC, so the configure script
+ will look for version 5.6 or later.</para>
<para>For Win32 platforms, you should use the binary
supplied in the InstallShield (copy it to
<title>Quick Start</title>
<para>If you are starting from a source distribution, and just
- want a completely standard build, then the following should
- work:</para>
+ want a completely standard build, then the following procedure should
+ work (unless you're on Windows, in which case go to <xref linkend="winbuild" />).</para>
<screen>$ autoreconf
$ ./configure
</varlistentry>
<varlistentry>
- <term><literal>EXCLUDE_SRCS</literal>
- <indexterm><primary><literal>EXCLUDE_SRCS</literal></primary></indexterm>
+ <term><literal>EXCLUDED_SRCS</literal>
+ <indexterm><primary><literal>EXCLUDED_SRCS</literal></primary></indexterm>
</term>
<listitem>
<para>Set to a list of source files (relative to the
<varlistentry>
<term><literal>EXTRA_SRCS</literal>
- <indexterm><primary><literal>EXCLUDE_SRCS</literal></primary></indexterm>
+ <indexterm><primary><literal>EXTRA_SRCS</literal></primary></indexterm>
</term>
<listitem>
<para>Set to a list of extra source files (perhaps
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 & 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>
<indexterm><primary>DocBook, pre-supposed</primary></indexterm>
</term>
<listitem>
- <para>Much of our documentation is written in SGML, using
- the DocBook DTD. Instructions on installing and
- configuring the DocBook tools are below.</para>
+ <para>Much of our documentation is written in DocBook XML, instructions
+ on installing and configuring the DocBook tools are below.</para>
</listitem>
</varlistentry>
<sect3>
<title>Installing the DocBook tools on Linux</title>
- <para>If you're on a recent RedHat system (7.0+), you probably
- have working DocBook tools already installed. The configure
- script should detect your setup and you're away.</para>
+ <para>If you're on a recent RedHat (7.0+) or SuSE (8.1+) system,
+ you probably have working DocBook tools already installed. The
+ configure script should detect your setup and you're away.</para>
<para>If you don't have DocBook tools installed, and you are
- using a system that can handle RedHat RPM packages, you can
- probably use the <ulink
- url="http://sourceware.cygnus.com/docbook-tools/">Cygnus
- DocBook tools</ulink>, which is the most shrink-wrapped SGML
- suite that we could find. You need all the RPMs except for
- psgml (i.e. <filename>docbook</filename>,
- <filename>jade</filename>, <filename>jadetex</filename>,
- <filename>sgmlcommon</filename> and
- <filename>stylesheets</filename>). Note that most of these
- RPMs are architecture neutral, so are likely to be found in a
- <filename>noarch</filename> directory. The SuSE RPMs also
- work; the RedHat ones <emphasis>don't</emphasis> in RedHat 6.2
- (7.0 and later should be OK), but they are easy to fix: just
- make a symlink from
- <filename>/usr/lib/sgml/stylesheets/nwalsh-modular/lib/dblib.dsl</filename>
- to <filename>/usr/lib/sgml/lib/dblib.dsl</filename>. </para>
+ using a system that can handle RPM packages, you can use <ulink
+ url="http://rpmfind.net/">Rpmfind.net</ulink> to find suitable
+ packages for your system. Search for the packages
+ <literal>docbook-dtd</literal>,
+ <literal>docbook-xsl-stylesheets</literal>,
+ <literal>libxslt</literal>,
+ <literal>libxml2</literal>,
+ <literal>fop</literal>,
+ <literal>xmltex</literal>, and
+ <literal>dvips</literal>.</para>
</sect3>
<sect3>
<sect3>
<title>Installing from binaries on Windows</title>
- <para>It's a good idea to use Norman Walsh's <ulink
- url="http://nwalsh.com/docbook/dsssl/doc/install.html">installation
- notes</ulink> as a guide. You should get version 3.1 of
- DocBook, and note that his file <filename>test.sgm</filename>
- won't work, as it needs version 3.0. You should unpack Jade
- into <filename>\Jade</filename>, along with the entities,
- DocBook into <filename>\docbook</filename>, and the DocBook
- stylesheets into <filename>\docbook\stylesheets</filename> (so
- they actually end up in
- <filename>\docbook\stylesheets\docbook</filename>).</para>
+ <para>Probably the fastest route to a working DocBook environment on
+ Windows is to install <ulink url="http://www.cygwin.com/">Cygwin</ulink>
+ with the complete <literal>Doc</literal> category. If you are using
+ <ulink url="http://www.mingw.org/">MinGW</ulink> for compilation, you
+ have to help <command>configure</command> a little bit: Set the
+ environment variables <envar>XmllintCmd</envar> and
+ <envar>XsltprocCmd</envar> to the paths of the Cygwin executables
+ <command>xmllint</command> and <command>xsltproc</command>,
+ respectively, and set <envar>fp_cv_dir_docbook_xsl</envar> to the path
+ of the directory where the XSL stylesheets are installed,
+ e.g. <filename>c:/cygwin/usr/share/docbook-xsl</filename>.
+ </para>
+
+ <para>If you want to build HTML Help, you have to install the
+ <ulink url="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/htmlhelp/html/hworiHTMLHelpStartPage.asp">HTML Help SDK</ulink>,
+ too, and make sure that <command>hhc</command> is in your <envar>PATH</envar>.</para>
</sect3>
-
- <sect3>
- <title>Installing the DocBook tools from source</title>
-
- <sect4>
- <title>Jade</title>
-
- <para>Install <ulink
- url="http://openjade.sourceforge.net/">OpenJade</ulink>
- (Windows binaries are available as well as sources). If you
- want DVI, PS, or PDF then install JadeTeX from the
- <filename>dsssl</filename> subdirectory. (If you get the
- error:
-
-<screen>! LaTeX Error: Unknown option implicit=false' for package hyperref'.</screen>
-
- your version of <command>hyperref</command> is out of date;
- download it from CTAN
- (<filename>macros/latex/contrib/supported/hyperref</filename>),
- and make it, ensuring that you have first removed or renamed
- your old copy. If you start getting file not found errors
- when making the test for <command>hyperref</command>, you
- can abort at that point and proceed straight to
- <command>make install</command>, or enter them as
- <filename>../</filename><emphasis>filename</emphasis>.)</para>
-
- <para>Make links from <filename>virtex</filename> to
- <filename>jadetex</filename> and
- <filename>pdfvirtex</filename> to
- <filename>pdfjadetex</filename> (otherwise DVI, PostScript
- and PDF output will not work). Copy
- <filename>dsssl/*.{dtd,dsl}</filename> and
- <filename>catalog</filename> to
- <filename>/usr/[local/]lib/sgml</filename>.</para>
- </sect4>
-
- <sect4>
- <title>DocBook and the DocBook stylesheets</title>
-
- <para>Get a Zip of <ulink
- url="http://www.oasis-open.org/docbook/sgml/3.1/index.html">DocBook</ulink>
- and install the contents in
- <filename>/usr/[local/]/lib/sgml</filename>.</para>
-
- <para>Get the <ulink
- url="http://nwalsh.com/docbook/dsssl/">DocBook
- stylesheets</ulink> and install in
- <filename>/usr/[local/]lib/sgml/stylesheets</filename>
- (thereby creating a subdirectory docbook). For indexing,
- copy or link <filename>collateindex.pl</filename> from the
- DocBook stylesheets archive in <filename>bin</filename> into
- a directory on your <constant>PATH</constant>.</para>
-
- <para>Download the <ulink
- url="http://www.oasis-open.org/cover/ISOEnts.zip">ISO
- entities</ulink> into
- <filename>/usr/[local/]lib/sgml</filename>.</para>
- </sect4>
- </sect3>
</sect2>
<sect2>
</sect2>
<sect2>
- <title>Remaining problems</title>
-
- <para>If you install from source, you'll get a pile of warnings
- of the form
-
-<screen>DTDDECL catalog entries are not supported</screen>
-
- every time you build anything. These can safely be ignored, but
- if you find them tedious you can get rid of them by removing all
- the <constant>DTDDECL</constant> entries from
- <filename>docbook.cat</filename>.</para>
- </sect2>
-
- <sect2>
<title>Building the documentation</title>
<para>To build documentation in a certain format, you can
<para>Because there are many different formats that the DocBook
documentation can be generated in, you have to select which ones
- you want by setting the <literal>SGMLDocWays</literal> variable
+ you want by setting the <literal>XMLDocWays</literal> variable
to a list of them. For example, in
<filename>build.mk</filename> you might have a line:</para>
-<screen>SGMLDocWays = html ps</screen>
+<screen>XMLDocWays = html ps</screen>
<para>This will cause the documentation to be built in the requested
formats as part of the main build (the default is not to build
documentation, which goes into
<literal>$(datadir)/html</literal>, to keep things tidy.</para>
- <para>Note that unless you set <literal>$(SGMLDocWays)</literal>
+ <para>Note that unless you set <literal>$(XMLDocWays)</literal>
to a list of formats, the <literal>install-docs</literal> target
- won't do anything for SGML documentation.</para>
+ won't do anything for DocBook XML documentation.</para>
</sect2>
</sect1>
<para>Bootstrapping GHC on a system without GHC already
installed is achieved by taking the intermediate C files (known
- as HC files) from a GHC compilation on a supported system to the
- target machine, and compiling them using gcc to get a working
- GHC.</para>
+ as HC files) from another GHC compilation, compiling them using gcc to
+ get a working GHC.</para>
<para><emphasis>NOTE: GHC versions 5.xx were hard to bootstrap
from C. We recommend using GHC 6.0.1 or
later.</emphasis></para>
<para>HC files are platform-dependent, so you have to get a set
- that were generated on similar hardware. There may be some
- supplied on the GHC download page, otherwise you'll have to
- compile some up yourself, or start from
- <emphasis>unregisterised</emphasis> HC files - see <xref
- linkend="unregisterised-porting"/>.</para>
+ that were generated on <emphasis>the same platform</emphasis>. There
+ may be some supplied on the GHC download page, otherwise you'll have to
+ compile some up yourself, or start from
+ <emphasis>unregisterised</emphasis> HC files - see <xref
+ linkend="unregisterised-porting"/>.</para>
<para>The following steps should result in a working GHC build
with full libraries:</para>
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>
<sect3>
<title>Cross-compiling to produce an unregisterised GHC</title>
+ <para>NOTE! These instructions apply to GHC 6.4 and (hopefully)
+ later. If you need instructions for an earlier version of GHC, try
+ to get hold of the version of this document that was current at the
+ time. It should be available from the appropriate download page on
+ the <ulink
+ url="http://www.haskell.org/ghc/">GHC homepage</ulink>.</para>
+
<para>In this section, we explain how to bootstrap GHC on a
new platform, using unregisterised intermediate C files. We
haven't put a great deal of effort into automating this
<listitem>
<screen>$ cd <replaceable>T</replaceable>/ghc/includes
-$ make config.h</screen>
+$ make</screen>
</listitem>
</itemizedlist>
</listitem>
with the following contents:</para>
<programlisting>GhcUnregisterised = YES
-GhcLibHcOpts = -O -H32m -keep-hc-files
+GhcLibHcOpts = -O -fvia-C -keep-hc-files
+GhcRtsHcOpts = -keep-hc-files
GhcLibWays =
SplitObjs = NO
GhcWithNativeCodeGen = NO
GhcWithInterpreter = NO
-GhcStage1HcOpts = -O -H32m -fasm
-GhcStage2HcOpts = -O -fvia-C -keep-hc-files</programlisting>
+GhcStage1HcOpts = -O
+GhcStage2HcOpts = -O -fvia-C -keep-hc-files
+SRC_HC_OPTS += -H32m
+GhcBootLibs = YES</programlisting>
</listitem>
<listitem>
<listitem>
<para>Copy
- <filename><replaceable>T</replaceable>/ghc/includes/config.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>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>
+ <para>Touch the generated configuration files, just to make
+ sure they don't get replaced during the build:</para>
+<screen>$ cd <filename><replaceable>H</replaceable></filename>/ghc/includes
+$ touch ghcautoconf.h DerivedConstants.h GHCConstants.h mkDerivedConstants.c
+$ touch mkDerivedConstantsHdr mkDerivedConstants.o mkGHCConstants mkGHCConstants.o</screen>
+
+ <para>Note: it has been reported that these files still get
+ overwritten during the next stage. We have installed a fix
+ for this in GHC 6.4.2, but if you are building a version
+ before that you need to watch out for these files getting
+ overwritte by the <literal>Makefile</literal> in
+ <literal>ghc/includes</literal>. If your system supports
+ it, you might be able to prevent it by making them
+ immutable:</para>
+<screen>$ chflags uchg ghc/includes/{ghcautoconf.h,DerivedConstants.h,GHCConstants.h}</screen>
</listitem>
<listitem>
</listitem>
<listitem>
-<screen>$ cd <replaceable>H</replaceable>/ghc
+<screen>$ cd <replaceable>H</replaceable>/ghc/compiler
$ make boot stage=2 && make stage=2</screen>
</listitem>
-
+
<listitem>
-<screen>$ cd <replaceable>H</replaceable>/ghc/utils
+<screen>$ cd <replaceable>H</replaceable>/ghc/lib/compat
$ make clean
-$ make -k HC=<replaceable>H</replaceable>/ghc/compiler/stage1/ghc-inplace \
- EXTRA_HC_OPTS='-O -fvia-C -keep-hc-files'</screen>
+$ rm .depend
+$ make boot UseStage1=YES
+$ make -k UseStage1=YES EXTRA_HC_OPTS='-O -fvia-C -keep-hc-files'
+$ cd <replaceable>H</replaceable>/ghc/utils
+$ make clean
+$ make -k UseStage1=YES EXTRA_HC_OPTS='-O -fvia-C -keep-hc-files'</screen>
</listitem>
<listitem>
</para>
</sect3>
+<sect3><title>Crippled <command>ld</command></title>
+
+<para>
+It turns out that on both Cygwin and MSYS, the <command>ld</command> has a
+limit of 32kbytes on its command line. Especially when using split object
+files, the make system can emit calls to <command>ld</command> with thousands
+of files on it. Then you may see something like this:
+<programlisting>
+(cd Graphics/Rendering/OpenGL/GL/QueryUtils_split && /mingw/bin/ld -r -x -o ../QueryUtils.o *.o)
+/bin/sh: /mingw/bin/ld: Invalid argument
+</programlisting>
+The solution is either to switch off object file splitting (set
+<option>SplitObjs</option> to <literal>NO</literal> in your
+<filename>build.mk</filename>),
+or to make the module smaller.
+</para>
+</sect3>
+
<sect3><title>Host System vs Target System</title>
<para>
<listitem><para>
Set the following environment variables
<itemizedlist>
- <listitem><para><literal>PATH</literal>: add <literal>c:/msys/1.0/bin</literal> to your path. (Of course, the version number may differ.)
+ <listitem><para><literal>PATH</literal>: add <literal>c:/msys/1.0/bin</literal> and
+ <literal>c:/msys/1.0/local/bin</literal>
+ to your path. (Of course, the version number may differ.)
+ MSYS mounts the former as both <literal>/bin</literal> and
+ <literal>/usr/bin</literal> and the latter as <literal>/usr/local/bin</literal>.
</para></listitem>
<listitem><para><literal>HOME</literal>: set to your home directory (e.g. <literal>c:/userid</literal>).
</para>
</sect2>
-<sect2><title>Installing and configuring Cygwin</title>
+<sect2 id="install-cygwin"><title>Installing and configuring Cygwin</title>
<para> Install Cygwin from <ulink url="http://www.cygwin.com/">http://www.cygwin.com/</ulink>.
-The installation process is straightforward; we install it in <filename>c:/cygwin</filename>.
-During the installation dialogue, make sure that you select all of the following:
+The installation process is straightforward; we install it in
+<filename>c:/cygwin</filename>.</para>
+<para>
+You must install enough Cygwin <emphasis>packages</emphasis> to support
+building GHC. If you miss out any of these, strange things will happen to you. There are two ways to do this:
+<itemizedlist>
+<listitem><para>The direct, but laborious way is to
+select all of the following packages in the installation dialogue:
<command>cvs</command>,
<command>openssh</command>,
<command>autoconf</command>,
<command>gcc</command>,
<command>flex</command>,
<command>make</command>.
-If you miss out any of these, strange things will happen to you. To see thse packages,
+To see thse packages,
click on the "View" button in the "Select Packages"
stage of Cygwin's installation dialogue, until the view says "Full". The default view, which is
"Category" isn't very helpful, and the "View" button is rather unobtrousive.
</para>
+</listitem>
+
+<listitem><para>The clever way is to point the Cygwin installer at the
+<command>ghc-depends</command> package, which is kept at <ulink
+url="http://haskell.org/ghc/cygwin">http://haskell.org/ghc/cygwin</ulink>.
+When the Cygwin installer asks you to "Choose a Download Site", choose one of
+the
+offered mirror sites; and then type "http://haskell.org/ghc/cygwin" into the
+"User URL" box and click "Add"; now two sites are selected. (The Cygwin
+installer remembers this for next time.)
+Click "Next".</para>
+<para>In the "Select Packages" dialogue box that follows, click the "+" sign by
+"Devel", scroll down to the end of the "Devel" packages, and choose
+<command>ghc-depends</command>.
+The package <command>ghc-depends</command> will not actually install anything itself,
+but forces additional packages to be added by the Cygwin installer.
+</para>
+</listitem>
+</itemizedlist>
+</para>
+
<para> Now set the following user environment variables:
<itemizedlist>
</itemizedlist>
</para>
-<para>
-There are a few other things to do:
-<itemizedlist>
-<listitem>
-<para>
-By default, cygwin provides the command shell <filename>ash</filename>
-as <filename>sh.exe</filename>. We have often seen build-system problems that
-turn out to be due to bugs in <filename>ash</filename>
-(to do with quoting
-and length of command lines). On the other hand <filename>bash</filename> seems
-to be rock solid.
-So, in <filename>cygwin/bin</filename>
-remove the supplied <filename>sh.exe</filename> (or rename it as <filename>ash.exe</filename>),
-and copy <filename>bash.exe</filename> to <filename>sh.exe</filename>.
-You'll need to do this in Windows Explorer or the Windows <command>cmd</command> shell, because
-you can't rename a running program!
-</para>
-</listitem>
-
-<listitem>
-<para>
-Some script files used in the make system start with "<command>#!/bin/perl</command>",
-(and similarly for <command>sh</command>). Notice the hardwired path!
-So you need to ensure that your <filename>/bin</filename> directory has the following
-binaries in it:
-<itemizedlist>
-<listitem> <para><command>sh</command></para></listitem>
-<listitem> <para><command>perl</command></para></listitem>
-<listitem> <para><command>cat</command></para></listitem>
-</itemizedlist>
-All these come in Cygwin's <filename>bin</filename> directory, which you probably have
-installed as <filename>c:/cygwin/bin</filename>. By default Cygwin mounts "<filename>/</filename>" as
-<filename>c:/cygwin</filename>, so if you just take the defaults it'll all work ok.
-(You can discover where your Cygwin
-root directory <filename>/</filename> is by typing <command>mount</command>.)
-Provided <filename>/bin</filename> points to the Cygwin <filename>bin</filename>
-directory, there's no need to copy anything. If not, copy these binaries from the <filename>cygwin/bin</filename>
-directory (after fixing the <filename>sh.exe</filename> stuff mentioned in the previous bullet).
-</para>
-</listitem>
-</itemizedlist>
-</para>
-
-<para>Finally, here are some things to be aware of when using Cygwin:
+<para>Here are some things to be aware of when using Cygwin:
<itemizedlist>
<listitem> <para>Cygwin doesn't deal well with filenames that include
spaces. "<filename>Program Files</filename>" and "<filename>Local files</filename>" are
See the notes in <xref linkend="msys-install"/> about <command>find</command> and <command>bzip</command>,
which apply to Cygwin too.
</para></listitem>
+
+<listitem>
+<para>
+Some script files used in the make system start with "<command>#!/bin/perl</command>",
+(and similarly for <command>sh</command>). Notice the hardwired path!
+So you need to ensure that your <filename>/bin</filename> directory has at least
+<command>sh</command>, <command>perl</command>, and <command>cat</command> in it.
+All these come in Cygwin's <filename>bin</filename> directory, which you probably have
+installed as <filename>c:/cygwin/bin</filename>. By default Cygwin mounts "<filename>/</filename>" as
+<filename>c:/cygwin</filename>, so if you just take the defaults it'll all work ok.
+(You can discover where your Cygwin
+root directory <filename>/</filename> is by typing <command>mount</command>.)
+Provided <filename>/bin</filename> points to the Cygwin <filename>bin</filename>
+directory, there's no need to copy anything. If not, copy these binaries from the <filename>cygwin/bin</filename>
+directory (after fixing the <filename>sh.exe</filename> stuff mentioned in the previous bullet).
+</para>
+</listitem>
+
+<listitem>
+<para>
+By default, cygwin provides the command shell <filename>ash</filename>
+as <filename>sh.exe</filename>. It seems to be fine now, but in the past we
+saw build-system problems that turned out to be due to bugs in <filename>ash</filename>
+(to do with quoting and length of command lines). On the other hand <filename>bash</filename> seems
+to be rock solid.
+If this happens to you (which it shouldn't), in <filename>cygwin/bin</filename>
+remove the supplied <filename>sh.exe</filename> (or rename it as <filename>ash.exe</filename>),
+and copy <filename>bash.exe</filename> to <filename>sh.exe</filename>.
+You'll need to do this in Windows Explorer or the Windows <command>cmd</command> shell, because
+you can't rename a running program!
+</para>
+</listitem>
</itemizedlist>
</para>
<sect2 id="configure-ssh"><title>Configuring SSH</title>
-<para><command>ssh</command> comes with Cygwin, provided you remember to ask for it when
-you install Cygwin. (If not, the installer lets you update easily.) Look for <command>openssh</command>
-(not ssh) in the Cygwin list of applications!</para>
+<para><command>ssh</command> comes with both Cygwin and MSYS.
+(Cygwin note: you need to ask for package <command>openssh</command> (not ssh)
+in the Cygwin list of packages; or use the <command>ghc-depends</command>
+package -- see <xref linkend="install-cygwin"/>.)</para>
<para>There are several strange things about <command>ssh</command> on Windows that you need to know.
<itemizedlist>
</listitem>
<listitem>
- <para>Install Alex. This can be done by building from the
+ <para>Install an executable Alex. This can be done by building from the
source distribution in the same way as Happy. Sources are
available from <ulink
url="http://www.haskell.org/alex">http://www.haskell.org/alex</ulink>.</para>
<ulink url="http://www.mingw.org/">http://www.mingw.org/</ulink>.
We install it in <filename>c:/mingw</filename>.
</para>
-<para>Do <emphasis>not</emphasis> add any of the <emphasis>mingw</emphasis> binaries to your path.
+
+<para><emphasis>On MSYS</emphasis>, add <literal>c:/mingw/bin</literal> to your PATH. MSYS does not provide <command>gcc</command>,
+<command>ld</command>, <command>ar</command>, and so on, because it just uses the MinGW ones. So you need them
+in your path.
+</para>
+
+<para><emphasis>On Cygwin, do not</emphasis> add any of the <emphasis>mingw</emphasis> binaries to your path.
They are only going to get used by explicit access (via the --with-gcc flag you
give to <command>configure</command> later). If you do add them to your path
-you are likely to get into a mess because their names overlap with Cygwin binaries.
+you are likely to get into a mess because their names overlap with Cygwin
+binaries.
+On the other hand, you <emphasis>do</emphasis> need <command>ld</command>, <command>ar</command>
+(and perhaps one or two other things) in your path. The Cygwin ones are fine,
+but you must have them; hence needing the Cygwin binutils package.
</para>
</listitem>
</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
</sect2>
+<sect2><title>A Windows build log using Cygwin</title>
+
+<para>Here is a complete, from-scratch, log of all you need to build GHC using
+Cygwin, kindly provided by Claus Reinke. It does not discuss alternative
+choices, but it gives a single path that works.</para>
+<programlisting>- Install some editor (vim, emacs, whatever)
+
+- Install cygwin (http://www.cygwin.com)
+ ; i used 1.5.16-1, installed in c:\cygwin
+ - run 'setup.exe'
+ Choose a Download Source:
+ select 'download from internet';
+ Select Root Install Directory:
+ root dir: c:\cygwin;
+ install for: all users;
+ default file type: unix
+ Select Local Package Directory
+ choose a spare temporary home
+ Select Your Internet Connection
+ Use IE5 settings
+ Choose a Download Site
+ Choose your preferred main mirror and
+ Add 'http://www.haskell.org/ghc/cygwin'
+ Select Packages
+ In addition to 'Base' (default install),
+ select 'Devel->ghc-depends'
+
+- Install mingw (http://www.mingw.org/)
+ ; i used MinGW-3.1.0-1.exe
+ ; installed in c:\mingw
+ - you probably want to add GLUT
+ ; (http://www.xmission.com/~nate/glut.html)
+ ; i used glut-3.7.3-mingw32.tar
+
+- Get recent binary snapshot of ghc-6.4.1 for mingw
+ ; (http://www.haskell.org/ghc/dist/stable/dist/)
+ - unpack in c:/ghc
+ - add C:\ghc\ghc-6.4.1\bin to %PATH%
+ (Start->Control Panel->System->Advanced->Environment Variables)
+
+- Get cvs version of ghc
+ ; also, subscribe to cvs-all@haskell.org, or follow the mailing list
+ ; archive, in case you checkout a version with problems
+ ; http://www.haskell.org//pipermail/cvs-all/
+ - mkdir c:/fptools; cd c:/fptools
+ ; (or whereever you want your cvs tree to be)
+ - export CVSROOT=:pserver:anoncvs@cvs.haskell.org:/cvs
+ - cvs login
+ ; pw: cvs
+ - cvs checkout fpconfig
+ - cd fptools
+ - cvs checkout ghc hslibs libraries
+
+- Build ghc, using cygwin and mingw, targetting mingw
+ - export PATH=/cygdrive/c/ghc/ghc-6.4.1:$PATH
+ ; for haddock, alex, happy (*)
+ - export PATH=/cygdrive/c/mingw/bin:$PATH
+ ; without, we pick up some cygwin tools at best!
+ - cd c:/fptools/fptools
+ ; (if you aren't there already)
+ - autoreconf
+ - ./configure --host=i386-unknown-mingw32 --with-gcc=C:/Mingw/bin/gcc.exe
+ ; we use cygwin, but build for windows
+ - cp mk/build.mk.sample mk/build.mk
+ - in mk/build.mk:
+ add line: SplitObjs = NO
+ (MSYS seems slow when there are zillions of object files)
+ uncomment line: BuildFlavour = perf
+ (or BuildFlavour = devel, if you are doing development)
+ add line: BIN_DIST=1
+ - make 2>&1 | tee make.log
+ ; always useful to have a log around
+
+- Package up binary distribution
+ - make binary-dist Project=Ghc 2>&1 | tee make-bin-dist.log
+ ; always useful to have a log around
+ - cd ghc-6.5
+ - chmod +x ../distrib/prep-bin-dist-mingw
+ ; if you're happy with the script's contents (*)
+ - ../distrib/prep-bin-dist-mingw
+ ; then tar up, unpack where wanted, and enjoy</programlisting>
+</sect2>
</sect1>
+<index/>
+
</article>
projects / ghc-hetmet.git / blobdiff