X-Git-Url: http://git.megacz.com/?a=blobdiff_plain;f=docs%2Fbuilding%2Fbuilding.sgml;h=30353c514352fe215c51bdad6e0c8419b50ca93f;hb=ed43e4820c5b0a486629d91f15288afdcea9dd44;hp=b63c1c83b3e220dbe2d8962eca13e57cb83d26d4;hpb=3b2322d63650813bb1b1a84b973d8eb95cf46260;p=ghc-hetmet.git
diff --git a/docs/building/building.sgml b/docs/building/building.sgml
index b63c1c8..30353c5 100644
--- a/docs/building/building.sgml
+++ b/docs/building/building.sgml
@@ -456,6 +456,10 @@ setsockopt IPTOS_THROUGHPUT: Invalid argument
hslibs and libraries
modules (for a full list of the projects available, see
).
+
+ Remember that if you do not have
+ happy installed, you need to check it out
+ as well.
@@ -491,7 +495,14 @@ $ cvs diff
you the results.
-
+
+ If you changed something in the
+ fptools/libraries subdirectories, also run
+ make html to check if the documentation can
+ be generated successfully, too.
+
+
+ Before checking in a change, you need to update your
source tree:
@@ -574,17 +585,25 @@ $ cvs commit -F commit-messagedirectory
major cause of headaches.
So, to avoid a lot of hassle, follow this recipe for
- updating your tree:
+ updating your tree:
$ cd fptools
-$ cvs update -Pd 2>&1 | tee log
+$ cvs update -P 2>&1 | tee log
Look at the log file, and fix any conflicts (denoted by a
- C 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:
+ C 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
+
+$ cvs update -d
+ in each project subdirectory. Don't do this at the top level,
+ because then all the projects will be
+ checked out.
+
+ 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:
$ cd build-tree
@@ -1205,6 +1224,12 @@ $ cvs checkout nofib/spectral
egcs) have varying degrees of stability
depending on the platform.
+ GCC 3.2 is currently known to have problems building
+ GHC on Sparc, but is stable on x86.
+
+ GCC 3.3 currently cannot be used to build GHC, due to
+ some problems with the new C preprocessor.
+
If your GCC dies with “internal error” 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
(fptools/happy). 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 Happy's Web
Page.
@@ -1252,6 +1277,10 @@ $ cvs checkout nofib/spectral
CVS sources, it is not needed if you
just intend to build a standard source distribution.
+ Version 2.52 or later of autoconf is required.
+ NB. vesrion 2.13 will no longer work, as of GHC version
+ 6.1.
+
Autoconf builds the configure
script from configure.in and
aclocal.m4. If you modify either of
@@ -1293,7 +1322,7 @@ $ cvs checkout nofib/spectral
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
@@ -1721,6 +1750,9 @@ $ make install
includes build.mk after
config.mk.)
+ For your convenience, there's a file called build.mk.sample
+ that can serve as a starting point for your build.mk.
+
For example, config.mk.in contains
the definition:
@@ -2207,7 +2239,7 @@ Foo.o : Baz.hi
Do NOT use
ghc/compiler/ghc, or
- ghc/compiler/ghc-5.xx, as these are the
+ ghc/compiler/ghc-6.xx, 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.
@@ -3593,10 +3625,10 @@ $ make install-docs
target machine, and compiling them using gcc to get a working
GHC.
- 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.
+ 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.HC files are architecture-dependent (but not
OS-dependent), so you have to get a set that were generated on
@@ -3718,11 +3750,11 @@ GhcWithRegisterised=NO
-# build.mk for GHC 5.xx
+# build.mk for GHC 5.xx and 6.x
GhcUnregisterised=YES
- Version 5.xx only: use the option
+ Versions 5.xx and 6.x only: use the option
instead of
when running
./configure.
@@ -4084,7 +4116,7 @@ guide) before continuing to read these notes.
-Cygwin and MinGW
+Cygwin and MinGW The Windows situation for building GHC is rather confusing. This section
tries to clarify, and to establish terminology.
@@ -4251,8 +4283,24 @@ There are a few other things to do:
+By default, cygwin provides the command shell ash
+as sh.exe. We have often seen build-system problems that
+turn out to be due to bugs in ash
+(to do with quoting
+and length of command lines). On the other hand bash seems
+to be rock solid.
+So, in cygwin/bin
+remove the supplied sh.exe (or rename it as ash.exe),
+and copy bash.exe to sh.exe.
+You'll need to do this in Windows Explorer or the Windows cmd shell, because
+you can't rename a running program!
+
+
+
+
+
Some script files used in the make system start with "#!/bin/perl",
-(and similarly for bash). Notice the hardwired path!
+(and similarly for sh). Notice the hardwired path!
So you need to ensure that your /bin directory has the following
binaries in it:
@@ -4264,21 +4312,10 @@ All these come in Cygwin's bin directory, which you probabl
installed as c:/cygwin/bin. By default Cygwin mounts "/" as
c:/cygwin, so if you just take the defaults it'll all work ok.
(You can discover where your Cygwin
-root directory / is by typing mount).
+root directory / is by typing mount.)
Provided /bin points to the Cygwin bin
-directory, there's no need to copy anything.
-
-
-
-
-
-By default, cygwin provides the command shell ash
-as sh.exe. It has a couple of 'issues' (to do with quoting
-and length of command lines), so
-in your /bin directory, make sure that
-bash.exe is also provided as sh.exe
-(i.e. overwrite the old sh.exe with a copy of
-bash.exe).
+directory, there's no need to copy anything. If not, copy these binaries from the cygwin/bin
+directory (after fixing the sh.exe stuff mentioned in the previous bullet).
@@ -4335,7 +4372,8 @@ Happy is a parser generator used to compile the Haskell grammar. Add it in your
GHC uses the mingw C compiler to
-generate code, so you have to install that. Just pick up a mingw bundle at
+generate code, so you have to install that (see ).
+Just pick up a mingw bundle at
http://www.mingw.org/.
We install it in c:/mingw.
@@ -4348,6 +4386,18 @@ you are likely to get into a mess because their names overlap with Cygwin binari
+We use emacs a lot, so we install that too.
+When you are in fptools/ghc/compiler, you can use
+"make tags" to make a TAGS file for emacs. That uses the utility
+fptools/ghc/utils/hasktags/hasktags, so you need to make that first.
+The most convenient way to do this is by going make boot in fptools/ghc.
+The make tags command also uses etags, which comes with emacs,
+so you will need to add emacs/bin to your PATH.
+
+
+
+
+ Finally, check out a copy of GHC sources from
the CVS repository, following the instructions above ().
@@ -4417,15 +4467,32 @@ This is the point at which you specify that you are building GHC-mingw
(see ). Both these options are important! It's possible to get into
-trouble using the wrong C compiler!
-Furthermore, it's very important that you specify a
-full mingw path for gcc, not a cygwin path, because GHC (which
-uses this path to invoke gcc) is a Mingw program and won't
-understand a cygwin path.. For example, if you
+trouble using the wrong C compiler!
+
+Furthermore, it's very important that you specify a
+full MinGW path for gcc, not a Cygwin path, because GHC (which
+uses this path to invoke gcc) is a MinGW program and won't
+understand a Cygwin path. For example, if you
say --with-gcc=/mingw/bin/gcc, it'll be interpreted as
/cygdrive/c/mingw/bin/gcc, and GHC will fail the first
-time it tries to invoke it. (Worse, the failure does not come with
-a helpful error message, unfortunately.)
+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:
+
+make[4]: Leaving directory `/cygdrive/e/fptools-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
+ -optc-Wbad-function-cast -optc-Wcast-align -optc-I../includes
+ -optc-I. -optc-Iparallel -optc-DCOMPILING_RTS
+ -optc-fomit-frame-pointer -O2 -static
+ -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: *** [all] Error 1
+
+Be warned!
@@ -4437,6 +4504,17 @@ you'll have to do something more like:
+ You almost certainly want to set
+
+ SplitObjs = NO
+
+in your build.mk configuration file (see ).
+This tells the build system not to split each library into a myriad of little object files, one
+for each function. Doing so reduces binary sizes for statically-linked binaries, but on Windows
+it dramatically increases the time taken to build the libraries in the first place.
+
+
+
Do not attempt to build the documentation.
It needs all kinds of wierd Jade stuff that we haven't worked out for
Win32.