|Version 43 (modified by simonpj, 5 months ago)|
This page lists the active repositories relating to GHC. For instructions on actually getting a GHC source tree, see Getting The Sources.
For read-only browsing, you can use the:
A GHC source tree is made of a collection of repositories. The script sync-all knows how to apply git commands to the whole collection of repositories at once, for example to pull changes from the upstream repositories.
The root of the source tree is the GHC repository itself, the other repositories live in various subdirectories.
Here is a list of the repositories that GHC uses. The columns have the following meaning
- Location in tree: where in the source tree this repository sits.
- Upstream repo?: if "yes", this library is maintained by someone else, and its master repo is somewhere else. See the page about upstream repositories.
- Reqd to build?: is "no" is this library is not required to build GHC. We have a few of these because we use them for tests and suchlike.
- Installed?: is "no" if the library is not installed in a GHC installation. All others are installed with GHC. See the libraries page for more info.
- GHC repo: in every case there is a repo on http://darcs.haskell.org/, which contains the bits we use for building GHC every night. For libraries with upstream repos, this is just a lagging mirror of the master (see upstream repositories)
|Location in tree||Upstream repo?||Reqd to build?||Installed?||GHC repo http://darcs.haskell.org/...|
|. (ghc itself)||ghc.git/|
The 'packages' file
The master list of repositories is in the file packages, and this is where the sync-all script finds out about which repositories make up the complete tree. It duplicates the information in the above table; indeed, it is really the authoritative version (so complain if the table and file differ!).
The "tag" in the master table in packages has the following significance:
- "-": boot libraries, necessary to build GHC
- "testsuite": GHC's regression tests, not necessary for a build, but is necessary if you're working on GHC
- "nofib": GHC's nofib benchmark suite
- "dph": packages for Data Parallel Haskell, which is not shipped with GHC but we test all changes to GHC against these repositories so they are usually included in a checked-out source tree.
- "extra": extra packages you might want to include in a build (the parallel package, for example), but aren't necessary to get a working GHC.
See the Commentary/Libraries page for more information about GHC's libraries.
Modifying local packages
For libraries for which there no upstream repo, you can modify the GHC repo above directly.
When making a change to a library, you must also update the version number if appropriate. Version number in the repositories should be maintained such that, if the library were to be release as-is, then they would have the correct version number. For example, if the last release of a library was 22.214.171.124 and you remove a function from it then, as per the Package versioning policy, the version number should be bumped to 126.96.36.199. If it is already 188.8.131.52 or higher then no further change is necessary. In order to make this easier, the version line in the .cabal file should be followed by a comment such as
-- GHC 7.6.1 released with 184.108.40.206
Mirroring new packages to GitHub
Currently, all our repositories are being mirrored to GitHub by GitHub themselves. If you wish to add/remove a repository you need to email GitHub support at support@… and ask them to do it. Currently there is no way to administer this ourselves.
For how we manage release branches, see WorkingConventions/Releases.
The following branches are active:
- 7.4 Branch
To switch to this branch run:
$ ./sync-all checkout ghc-7.4