X-Git-Url: http://git.megacz.com/?p=ghc-hetmet.git;a=blobdiff_plain;f=README;h=d36c6423545c3b1631cb1d75532d12a63e4e82d1;hp=c31549df937b2a3b4d967b73afa5f4edceae50a6;hb=90686adf9d3dc7a09a51853df051bc4ea472d840;hpb=b254336258c6bfe2612d399fa649c126d54f87ca diff --git a/README b/README index c31549d..d36c642 100644 --- a/README +++ b/README @@ -21,27 +21,32 @@ There are two ways to get a source tree: 1. Download source tarballs --------------------------- - The GHC source distribution comes in two parts: + Download the GHC source distribution: ghc--src.tar.bz2 - ghc--src-extralibs.tar.bz2 - You only need the first one, which contains GHC itself and - the "boot" libraries. + which contains GHC itself and the "boot" libraries. - The extralibs package contains a bunch of optional libraries. If - you want, you can unpack this over the top of your source tree, and - these extra libraries will be built and installed automatically. - Make sure you unpack the extralibs package before running configure - (see below). + 2. Check out the source code from darcs + --------------------------------------- - If you don't build extralibs now, you can add them later by building - and installing individual packages using Cabal. + The recommended way to get a darcs checkout is to start off by + downloading a snapshot with a name like: - 2. Get the source from darcs - ---------------------------- + ghc-HEAD-2009-09-09-ghc-corelibs-testsuite.tar.bz2 - First get the GHC darcs repository: + from: + + http://darcs.haskell.org/ + + and then untar it and bring it up-to-date with: + + $ cd ghc + $ ./darcs-all get + + + Alternatively you can use darcs to get the repos, but it will take a + lot longer. First get the GHC darcs repository: $ darcs get http://darcs.haskell.org/ghc/ @@ -52,13 +57,7 @@ There are two ways to get a source tree: $ chmod +x darcs-all $ ./darcs-all get - This grabs the "boot" packages by default. To get the full set of - packages, instead say - - $ ./darcs-all --extra get - - This also downloads the libraries that are normally bundled in the - "extralibs" package (see above). + This checks out the "boot" packages. Building & Installing @@ -69,15 +68,15 @@ Here follows a summary - if you get into trouble, the Building Guide has all the answers. NB. you need GHC installed in order to build GHC, because the compiler -is itself written in Haskell. It is possible to build GHC using just -a C compiler, but we don't recommend this as the normal route. If you -*really* want to do it this way, then see the Building Guide. +is itself written in Haskell. For instructions on how to port GHC to a +new platform, see the Building Guide. If you're building from darcs sources (as opposed to a source distribution) then you also need to install Happy [4] and Alex [5]. For building library documentation, you'll need Haddock [6]. To build -the compiler documentation, you need a good DocBook XML toolchain. +the compiler documentation, you need a good DocBook XML toolchain and +dblatex. Quick start: the following gives you a default build: @@ -90,16 +89,6 @@ The "sh boot" step is only necessary if this is a tree checked out from darcs. For source distributions downloaded from GHC's web site, this step has already been performed. -If you want the documentation too then use these commands instead: - - $ echo "XMLDocWays = html" > mk/build.mk - $ echo "HADDOCK_DOCS = YES" >> mk/build.mk - $ sh boot - $ ./configure - $ make - $ make install - $ make install-docs - These steps give you the default build, which includes everything optimised and built in various ways (eg. profiling libs are built). It can take a long time. To customise the build, see the file