X-Git-Url: http://git.megacz.com/?p=ghc-hetmet.git;a=blobdiff_plain;f=README;h=c31549df937b2a3b4d967b73afa5f4edceae50a6;hp=b1b408a7aa6556233a1ddc7229eadee3bdf7f85b;hb=bca61eb59ad615793175e4d1a3de7a243b41de44;hpb=f8dd6b45f393bc0742782cd705545971ba2205be diff --git a/README b/README index b1b408a..c31549d 100644 --- a/README +++ b/README @@ -1,60 +1,126 @@ -GHC build system -================ +The Glasgow Haskell Compiler +============================ -This is the top-level directory of the fptools build system. Several -packages are part of this build system; if you got this as part of a -source distribution (eg. for GHC), then you will have one or more of -the following directories: +This is the source tree for GHC, a compiler and interactive +environment for the Haskell functional programming language. - ghc The Glasgow Haskell Compiler - hslibs A Collection of Haskell libraries - haddock A Haskell documentation tool - haggis The Haggis GUI toolkit - happy The Happy Haskell parser generator - hdirect Haskell interop tool - greencard A foreign function interface pre-processor for Haskell. - libraries Haskell libraries (reqd. by ghc) - nofib The NoFib Haskell benchmarking suite +For more information, visit GHC's web site: -Additional documentation for each project can be found in its -respective directory. + http://www.haskell.org/ghc/ -In addition, the following directories contain project-independent bits: +Information for developers of GHC can be found here: - mk GNU make setup used by all of fptools - glafp-utils Shared utility programs - docs Documentation on the installing and using - the fptools build system. - distrib Tools and additional bits for building distributions + http://hackage.haskell.org/trac/ghc/ -Quick start: the following is *supposed* to work - $ ./configure - $ make - $ make install +Getting the Source +================== -where 'make' is whatever GNU make is called on your system (GNU make -is *required*). If there are any other tools required for the build, -then the configure script will detect them and tell you if any are -missing. For example, a working GHC installation is required for -building most of the tools (including GHC itself). +There are two ways to get a source tree: -The configuration script is a standard GNU autoconf script which -accepts all the normal arguments, eg. --prefix= to install the -package somewhere other than /usr/local. Try ./configure --help to -get a full list of the options. + 1. Download source tarballs + --------------------------- -There is usually an ANNOUNCE* file with any distribution. Please -consult that, or the /README file, to find out how to proceed. + The GHC source distribution comes in two parts: -Full documentation for the fptools build system can be found in the -Building Guide: + ghc--src.tar.bz2 + ghc--src-extralibs.tar.bz2 - http://www.haskell.org/ghc/docs/latest/html/building/building-guide.html + You only need the first one, which contains GHC itself and + the "boot" libraries. -More information about GHC can be found here: + 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). - http://www.haskell.org/ghc/ + If you don't build extralibs now, you can add them later by building + and installing individual packages using Cabal. --- -The GHC Team, glasgow-haskell-users@haskell.org + 2. Get the source from darcs + ---------------------------- + + First get the GHC darcs repository: + + $ darcs get http://darcs.haskell.org/ghc/ + + Then run the darcs-all script in that repository + to get the other repositories: + + $ cd ghc + $ 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). + + +Building & Installing +===================== + +For full information on building GHC, see the GHC Building Guide [3]. +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. + +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. + +Quick start: the following gives you a default build: + + $ sh boot + $ ./configure + $ make + $ make install + +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 +HACKING. + + + +References +========== + + [1] http://www.haskell.org/ghc/ GHC Home Page + [2] http://hackage.haskell.org/trac/ghc GHC Developer's Wiki + [3] http://hackage.haskell.org/trac/ghc/wiki/Building Building Guide + [4] http://www.haskell.org/happy/ Happy + [5] http://www.haskell.org/alex/ Alex + [6] http://www.haskell.org/haddock/ Haddock + + +Contributors +============ + +Please see + + http://www.haskell.org/ghc/contributors.html