<para>Like the source tree, the top level of your build tree
must be (a linked copy of) the root directory of the GHC source
tree.. Inside Makefiles, the root of your build tree is called
- <constant>$(FPTOOLS_TOP)</constant><indexterm><primary>FPTOOLS_TOP</primary></indexterm>.
+ <constant>$(GHC_TOP)</constant><indexterm><primary>GHC_TOP</primary></indexterm>.
In the rest of this document path names are relative to
- <constant>$(FPTOOLS_TOP)</constant> unless
+ <constant>$(GHC_TOP)</constant> unless
otherwise stated. For example, the file
<filename>mk/target.mk</filename> is actually
- <filename>$(FPTOOLS_TOP)/mk/target.mk</filename>.</para>
+ <filename>$(GHC_TOP)/mk/target.mk</filename>.</para>
</sect2>
<sect2 id="sec-build-config">
rather than darcs sources, you can skip this step.</para>
<para>Change directory to
- <constant>$(FPTOOLS_TOP)</constant> and
+ <constant>$(GHC_TOP)</constant> and
issue the command</para>
<screen>$ autoreconf</screen>
<indexterm><primary>autoreconf</primary></indexterm>
<para>(with no arguments). This GNU program (recursively) converts
- <filename>$(FPTOOLS_TOP)/configure.ac</filename> and
- <filename>$(FPTOOLS_TOP)/aclocal.m4</filename>
+ <filename>$(GHC_TOP)/configure.ac</filename> and
+ <filename>$(GHC_TOP)/aclocal.m4</filename>
to a shell script called
- <filename>$(FPTOOLS_TOP)/configure</filename>.
+ <filename>$(GHC_TOP)/configure</filename>.
If <command>autoreconf</command> bleats that it can't write the file <filename>configure</filename>,
then delete the latter and try again. Note that you must use <command>autoreconf</command>,
and not the old <command>autoconf</command>! If you erroneously use the latter, you'll get
libraries, have their own configure script.
<command>autoreconf</command> takes care of that, too, so all you have
to do is calling <command>autoreconf</command> in the top-level directory
- <filename>$(FPTOOLS_TOP)</filename>.</para>
+ <filename>$(GHC_TOP)</filename>.</para>
<para>These steps are completely platform-independent; they just mean
that the human-written files (<filename>configure.ac</filename> and
<para>You can also use <filename>build.mk</filename> to override
anything that <command>configure</command> got wrong. One place
where this happens often is with the definition of
- <constant>FPTOOLS_TOP_ABS</constant>: this
+ <constant>GHC_TOP_ABS</constant>: this
variable is supposed to be the canonical path to the top of your
source tree, but if your system uses an automounter then the
correct directory is hard to find automatically. If you find
<filename>Makefile</filename> for an imaginary small program,
<literal>small</literal>. Each program or library in the GHC
source tree typically has its own directory, in this case we'll
- use <filename>$(FPTOOLS_TOP)/small</filename>.
+ use <filename>$(GHC_TOP)/small</filename>.
Inside the <filename>small/</filename> directory there will be a
<filename>Makefile</filename>, looking something like
this:</para>
<indexterm><primary>boilerplate.mk</primary></indexterm>
<para>If you look at
- <filename>$(FPTOOLS_TOP)/mk/boilerplate.mk</filename>
+ <filename>$(GHC_TOP)/mk/boilerplate.mk</filename>
you will find that it consists of the following sections, each
held in a separate file:</para>
<title>Tools for building the Documentation</title>
<para>The following additional tools are required if you want to
- format the documentation that comes with the
- <literal>fptools</literal> projects:</para>
+ format the documentation that comes with GHC:</para>
<variablelist>
<varlistentry>
<listitem>
<para>Haddock is a Haskell documentation tool that we use
for automatically generating documentation from the
- library source code. It is an <literal>fptools</literal>
- project in itself. To build documentation for the
- libraries (<literal>fptools/libraries</literal>) you
- should check out and build Haddock in
- <literal>fptools/haddock</literal>. Haddock requires GHC
+ library source code. To build documentation for the
+ libraries (<literal>$(GHC_TOP)/libraries</literal>) you
+ should build and install Haddock. Haddock requires GHC
to build.</para>
</listitem>
</varlistentry>
<title>GHCi</title>
<para>To support GHCi, you need to port the dynamic linker
- (<filename>fptools/ghc/rts/Linker.c</filename>). The linker
+ (<filename>$(GHC_TOP)/rts/Linker.c</filename>). The linker
currently supports the ELF and PEi386 object file formats - if
your platform uses one of these then things will be
significantly easier. The majority of Unix platforms use the
<programlisting>export TMPDIR=<dir></programlisting>
-in your <filename>build.mk</filename> file.
-Then GHC and the other <literal>fptools</literal> programs will use the appropriate directory
-in all cases.
+in your <filename>build.mk</filename> file. Then GHC and the other
+tools will use the appropriate directory in all cases.
</para>
<para>You have to install the following other things to build GHC, listed below.</para>
<para>On Windows you often install executables in directories with spaces, such as
-"<filename>Program Files</filename>". However, the <literal>make</literal> system for fptools doesn't
+"<filename>Program Files</filename>". However, the <literal>make</literal> system doesn't
deal with this situation (it'd have to do more quoting of binaries), so you are strongly advised
to put binaries for all tools in places with no spaces in their path.
On both MSYS and Cygwin, it's perfectly OK to install such programs in the standard Unixy places,
<listitem>
<para>We use <command>emacs</command> a lot, so we install that too.
-When you are in <filename>fptools/ghc/compiler</filename>, you can use
+When you are in <filename>$(GHC_TOP)/compiler</filename>, you can use
"<literal>make tags</literal>" to make a TAGS file for emacs. That uses the utility
-<filename>fptools/ghc/utils/hasktags/hasktags</filename>, so you need to make that first.
-The most convenient way to do this is by going <literal>make boot</literal> in <filename>fptools/ghc</filename>.
+<filename>$(GHC_TOP)/ghc/utils/hasktags/hasktags</filename>, so you need to make that first.
+The most convenient way to do this is by going <literal>make boot</literal> in <filename>$(GHC_TOP)/ghc</filename>.
The <literal>make tags</literal> command also uses <command>etags</command>, which comes with <command>emacs</command>,
so you will need to add <filename>emacs/bin</filename> to your <literal>PATH</literal>.
</para>
<listitem>
<para>
After <command>autoreconf</command> run <command>./configure</command> in
- <filename>fptools/</filename> thus:
+ <filename>$(GHC_TOP)/</filename> thus:
<screen>$ ./configure --host=i386-unknown-mingw32 --with-gcc=c:/mingw/bin/gcc</screen>
This is the point at which you specify that you are building GHC-mingw
time it tries to invoke it. Worse, the failure comes with
no error message whatsoever. GHC simply fails silently when first invoked,
typically leaving you with this:
-<screen>make[4]: Leaving directory `/cygdrive/e/fptools-stage1/ghc/rts/gmp'
+<screen>make[4]: Leaving directory `/cygdrive/e/ghc-stage1/ghc/rts/gmp'
../../ghc/compiler/ghc-inplace -optc-mno-cygwin -optc-O
-optc-Wall -optc-W -optc-Wstrict-prototypes -optc-Wmissing-prototypes
-optc-Wmissing-declarations -optc-Winline -optc-Waggregate-return
-package-name rts -O -dcore-lint -c Adjustor.c -o Adjustor.o
make[2]: *** [Adjustor.o] Error 1
make[1]: *** [all] Error 1
-make[1]: Leaving directory `/cygdrive/e/fptools-stage1/ghc'
+make[1]: Leaving directory `/cygdrive/e/ghc-stage1/ghc'
make: *** [all] Error 1</screen>
Be warned!
</para>
; 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
+ - mkdir c:/ghc-build; cd c:/ghc-build
; (or whereever you want your darcs tree to be)
- darcs get http://darcs.haskell.org/ghc
- cd ghc
; for haddock, alex, happy (*)
- export PATH=/cygdrive/c/mingw/bin:$PATH
; without, we pick up some cygwin tools at best!
- - cd c:/fptools/fptools
+ - cd c:/ghc-build
; (if you aren't there already)
- autoreconf
- ./configure --host=i386-unknown-mingw32 --with-gcc=C:/Mingw/bin/gcc.exe
projects / ghc-hetmet.git / commitdiff