X-Git-Url: http://git.megacz.com/?a=blobdiff_plain;f=docs%2Fbuilding%2Fbuilding.sgml;h=7196bf1c499e8a7e6d9387eb8a29b20de025b660;hb=38178e3b480cbe8487df8ad3083c0938db5be7ac;hp=f0addddcd6c5e77795e16d5f8d2f2a786200ee31;hpb=dd13de3f983719be4beba1db9a98ac1fda641cc7;p=ghc-hetmet.git diff --git a/docs/building/building.sgml b/docs/building/building.sgml index f0adddd..7196bf1 100644 --- a/docs/building/building.sgml +++ b/docs/building/building.sgml @@ -58,7 +58,7 @@ the parser specifications. If you don't want to alter the parser then this saves you having to find and install happy. You will still need a working - version of GHC (preferably version 4.08+) on your machine in + version of GHC (version 5.x or later) on your machine in order to compile (most of) the sources, however. @@ -137,6 +137,12 @@ Set your $CVSROOT environment variable to :pserver:anoncvs@glass.cse.ogi.edu:/cvs + If you set $CVSROOT in a shell script, be sure not to + have any trailing spaces on that line, otherwise CVS will respond with + a perplexing message like + + /cvs : no such repository + Run the command @@ -434,8 +440,8 @@ setsockopt IPTOS_THROUGHPUT: Invalid argument ). Remember that if you do not have - happy installed, you need to check it out - as well. + happy and/or Alex + installed, you need to check them out as well. @@ -1000,12 +1006,21 @@ $ cvs checkout nofib/spectral sparc-sun-solaris2 sparc-sun-solaris2 - Fully supported (at least for Solaris 2.7), + Fully supported (at least for Solaris 2.7 and 2.6), including native-code generator. + sparc-unknown-openbsd + sparc-unknown-openbsd + + Supported, including native-code generator. The + same should also be true of NetBSD + + + + hppa1.1-hp-hpux (HP-PA boxes running HPUX 9.x) hppa1.1-hp-hpux @@ -1080,8 +1095,8 @@ $ cvs checkout nofib/spectral ia64-unknown-linux ia64-unknown-linux - GHC currently works unregisterised. A registerised - port is in progress. + Supported, except there is no native code + generator. @@ -1107,6 +1122,14 @@ $ cvs checkout nofib/spectral + mips64-sgi-irix6 + mips-sgi-irix6 + + GHC currently works unregisterised. + + + + powerpc-ibm-aix powerpc-ibm-aix @@ -1262,22 +1285,35 @@ $ cvs checkout nofib/spectral - Autoconf - pre-supposed: Autoconf - Autoconf, pre-supposed + Alex + Alex - GNU Autoconf is needed if you intend to build from the + 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 Alex's Web + Page. + + + + + Autoreconf + pre-supposed: Autoreconf + Autoreconf, pre-supposed + + GNU Autoreconf is needed if you intend to build from the 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. + Version 2.52 or later of autoreconf is required. NB. vesrion 2.13 will no longer work, as of GHC version 6.1. - Autoconf builds the configure + Autoreconf builds the configure script from configure.ac and aclocal.m4. If you modify either of - these files, you'll need autoconf to + these files, you'll need autoreconf to rebuild configure. @@ -1398,7 +1434,8 @@ $ cvs checkout nofib/spectral want a completely standard build, then the following should work: -$ ./configure +$ autoreconf +$ ./configure $ make $ make install @@ -1570,20 +1607,27 @@ $ make install Change directory to $(FPTOOLS_TOP) and issue the command - autoconfautoconf + +autoreconf + + autoreconf (with no arguments). This GNU program converts $(FPTOOLS_TOP)/configure.ac to a shell script called $(FPTOOLS_TOP)/configure. + If autoreconf bleats that it can't write the file configure, + then delete the latter and try again. Note that you must use autoreconf, + and not the old autoconf! If you erroneously use the latter, you'll get + a message like "No rule to make target 'mk/config.h.in'". Some projects, including GHC, have their own configure script. If there's an $(FPTOOLS_TOP)/<project>/configure.ac, - then you need to run autoconf in that + then you need to run autoreconf in that directory too. - Both these steps are completely + These steps are completely platform-independent; they just mean that the human-written file (configure.ac) can be short, although the resulting shell script, @@ -1863,7 +1907,7 @@ $ cd /scratch/joe-bloggs/myfptools-sun4 Prepare for system configuration: -$ autoconf +$ autoreconf (You can skip this step if you are starting from a @@ -1872,11 +1916,11 @@ $ autoconf mk/config.h.in.) Some projects, including GHC itself, have their own - configure scripts, so it is necessary to run autoconf again + configure scripts, so it is necessary to run autoreconf again in the appropriate subdirectories. eg: -$ (cd ghc; autoconf) +$ (cd ghc; autoreconf) @@ -2238,7 +2282,8 @@ Foo.o : Baz.hi build tree. Happy can similarly be run from the build tree, using - happy/src/happy-inplace. + happy/src/happy-inplace, and similarly for + Alex and Haddock. @@ -3756,6 +3801,7 @@ foo% make install +$ cd T $ ./configure --enable-hc-boot --enable-hc-boot-unregisterised @@ -3809,23 +3855,18 @@ GhcStage2HcOpts = -O -fvia-C -keep-hc-files - Copy - T/ghc/includes/config.h - to - H/ghc/includes. - Note that we are building on the host machine, using the - target machine's config.h file. This - is so that the intermediate C files generated here will - be suitable for compiling on the target system. - - - Edit H/mk/config.mk: change TARGETPLATFORM - appropriately. + appropriately, and set the variables involving + TARGET to the correct values for + the target platform. This step is necessary because + currently configure doesn't cope + with specifying different values for the + --host and + --target flags. copy LeadingUnderscore @@ -3833,18 +3874,32 @@ GhcStage2HcOpts = -O -fvia-C -keep-hc-files - + - -$ cd H/glafp-utils && make boot && make - + Copy + T/ghc/includes/config.h + to + H/ghc/includes. + Note that we are building on the host machine, using the + target machine's config.h file. This + is so that the intermediate C files generated here will + be suitable for compiling on the target system. + - + + + Touch config.h, just to make + sure it doesn't get replaced during the build: + +$ touch H/ghc/includes/config.h + + + Now build the compiler: +$ cd H/glafp-utils && make boot && make $ cd H/ghc && make boot && make - Don't worry if the build falls over in the RTS, we don't need the RTS yet. @@ -4060,10 +4115,13 @@ Hello World! To support GHCi, you need to port the dynamic linker (fptools/ghc/rts/Linker.c). The linker currently supports the ELF and PEi386 object file formats - if - your platform uses one of these then you probably don't have - to do anything except fiddle with the - #ifdefs at the top of - Linker.c to tell it about your OS. + your platform uses one of these then things will be + significantly easier. The majority of Unix platforms use the + ELF format these days. Even so, there are some + machine-specific parts of the ELF linker: for example, the + code for resolving particular relocation types is + machine-specific, so some porting of this code to your + architecture will probaly be necessary. If your system uses a different object file format, then you have to write a linker — good luck! @@ -4395,14 +4453,37 @@ but you do need it to build GHC. Install Cygwin from http://www.cygwin.com/. The installation process is straightforward; we install it in c:/cygwin. -During the installation dialogue, make sure that you select: -cvs, openssh, -autoconf, -binutils (includes ld and (I think) ar), -gcc, -flex, -make. - +During the installation dialogue, make sure that you select all of the following: + + + cvs, + + + openssh, + + + autoreconf, + + + automake, + + + binutils (includes ld and (I think) ar), + + + gcc, + + + flex, + + + make. + + +If you miss out any of these, strange things will happen to you. 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. Now set the following user environment variables: @@ -4422,7 +4503,7 @@ don't do this you get very weird messages when you type Set SHELL to -c:/cygwin/bin/sh. When you invoke a shell in Emacs, this +c:/cygwin/bin/bash. When you invoke a shell in Emacs, this SHELL is what you get. @@ -4592,6 +4673,12 @@ Happy is a parser generator used to compile the Haskell grammar. Add it in your + + Install Alex. This can be done by building from the + source distribution in the usual way. Sources are + available from http://www.haskell.org/alex. + GHC uses the mingw C compiler to @@ -4638,7 +4725,7 @@ you about Windows-specific wrinkles. -Run autoconf both in fptools +Run autoreconf both in fptools and in fptools/ghc. If you omit the latter step you'll get an error when you run ./configure: @@ -4653,11 +4740,11 @@ configure: error: ./configure failed for ghc - autoconf seems to create the file configure -read-only. So if you need to run autoconf again (which I sometimes do for safety's sake), + autoreconf seems to create the file configure +read-only. So if you need to run autoreconf again (which I sometimes do for safety's sake), you get -/usr/bin/autoconf: cannot create configure: permission denied +/usr/bin/autoreconf: cannot create configure: permission denied Solution: delete configure first. @@ -4680,7 +4767,7 @@ can be really confusing. - After autoconf run ./configure in + After autoreconf run ./configure in fptools/ thus: