Version 15 (modified by guest, 7 years ago)

--

Getting a GHC source tree

The first thing to do is install  darcs.

A source tree consists of the GHC repository, with a set of packages in the libraries directory. We supply a script to automate the checking out of packages, darcs-all. Checking out a tree goes like this:

  $ darcs get --partial http://darcs.haskell.org/ghc
  $ cd ghc
  $ chmod +x darcs-all
  $ ./darcs-all get

NOTE: you really want --partial when grabbing GHC. There are some 13000 patches in the repository, which take a long time to download without --partial. The darcs-all script automatically adds --partial for the packages.

The above will grab the "core" set of packages. This is the minimal set of packages required to bootstrap GHC. If you want to get a more comprehensive set of packages and include them in your GHC build, then you can say:

  $ ./darcs-all --extra get

This isn't usually necessary: extra packages can be compiled and installed separately using Cabal, after you have built and installed GHC itself with its core packages. The list of "core" and "extra" packages is below.

Optionally, you might want to grab the testsuite and benchmark suite too, which should also be sub-directories of ghc:

  $ darcs get --partial http://darcs.haskell.org/testsuite
  $ darcs get --partial http://darcs.haskell.org/nofib

List of repositories

These darcs repositories are related to GHC:

 http://darcs.haskell.org/ghcThe main GHC repository
 http://darcs.haskell.org/testsuiteThe test suite (requires python 2.4+)
 http://darcs.haskell.org/nofibThe benchmark suite

The following repositories are the "core" packages, that populate the libraries directory of a GHC tree:

 http://darcs.haskell.org/packages/base
 http://darcs.haskell.org/packages/Cabal
 http://darcs.haskell.org/packages/haskell98
 http://darcs.haskell.org/packages/readline
 http://darcs.haskell.org/packages/regex-base
 http://darcs.haskell.org/packages/regex-posix
 http://darcs.haskell.org/packages/regex-compat
 http://darcs.haskell.org/packages/stm
 http://darcs.haskell.org/packages/template-haskell
 http://darcs.haskell.org/packages/unix
 http://darcs.haskell.org/packages/Win32

And the following repositories are the "extra" packages:

 http://darcs.haskell.org/packages/ALUT
 http://darcs.haskell.org/packages/GLUT
 http://darcs.haskell.org/packages/HGL
 http://darcs.haskell.org/packages/HUnit
 http://darcs.haskell.org/packages/HaXml
 http://darcs.haskell.org/packages/Japi
 http://darcs.haskell.org/packages/ObjectIO
 http://darcs.haskell.org/packages/OpenAL
 http://darcs.haskell.org/packages/OpenGL
 http://darcs.haskell.org/packages/QuickCheck
 http://darcs.haskell.org/packages/X11
 http://darcs.haskell.org/packages/arrows
 http://darcs.haskell.org/packages/fgl
 http://darcs.haskell.org/packages/haskell-src
 http://darcs.haskell.org/packages/html
 http://darcs.haskell.org/packages/monads
 http://darcs.haskell.org/packages/mtl
 http://darcs.haskell.org/packages/network
 http://darcs.haskell.org/packages/parsec
 http://darcs.haskell.org/packages/time
 http://darcs.haskell.org/packages/xhtml

There are no branches currently; we will use CVS for the 6.4 branch until its end of life, and use darcs for future branches.

Pulling new patches

To update your tree from the master repositories, the quickest way is to use the darcs-all script:

  $ ./darcs-all pull -a

Submitting patches

To submit patches to the developers, please use darcs send. You don't need any special permission to do this.

Committing changes

If you have commit permission (pretty easy to get, just demonstrate your competence by sending us a patch or two first), then you can use darcs push to commit changes directly to the main repository.

  $ darcs push <account>@darcs.haskell.org:/home/darcs/ghc

(change ghc to the name of the repository if you're pushing changes from one of the sub-repositories, like testsuite, or a package such as base. Note: darcs push requires that SSH is working and can log in to your account on darcs.haskell.org.

Do not forget to darcs record your changes first!

Please test changes before committing: you can run a cut-down version of the full test suite like this:

  $ cd testsuite
  $ make boot
  $ make fast

You need to have testsuite checked out, of course. Running make fast should only take a few minutes.