Changes between Version 10 and Version 11 of Repositories

Aug 4, 2011 7:53:53 AM (6 years ago)



  • Repositories

    v10 v11  
    77GHC's repos use Git; see [wiki:WorkingConventions/Git].  For Darcs-related stuff see also [wiki:DarcsToGit] and [wiki:GitForDarcsUsers].  For instructions for building from !GitHub sources, see [wiki:GitHubGHC].
    9 == The HEAD ==
     9== Overview ==
    11 The Master List of repositories is in the file [ $(TOP)/packages].  It is authoritative.  Everything else in this sub-section may be out of date, although it gives the right general idea.
     11A GHC source tree is made of a collection of repositories.  The script [wiki:Building/SyncAll 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.
    13 These repositories are the HEAD (main trunk) of GHC development:
     13The root of the source tree is the GHC repository itself, the other repositories live in various subdirectories.  The Master List of repositories is in the file source:packages, and this is where the `sync-all` script finds out about which repositories make up the complete tree.
    15 ||[]||The main GHC repository||
    16 ||[]||The test suite (requires python 2.4+) ||
    17 ||[]||The benchmark suite||
     15Some repositories are optional:
    19 Our repositories are either git repo, or darcs "hashed" format repos. You need Darcs version 2 or later (preferably 2.4 or later) to get the darcs repos. Use darcs's `--lazy` option when getting the repository remotely to dramatically speed up the transfer.
     17 * The `testsuite` is not necessary for a build, but is necessary if you're working on GHC
     18 * The `nofib` repository is for benchmarking
     19 * The `dph` repositories provide 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.
     20 * The `extra` repositories are some extra packages you might want to include in a build (the `parallel` package, for example), but aren't necessary to get a working GHC.
    21 The following repositories are the "GHC boot" libraries, i.e. the set of libraries that are necessary to build GHC (i.e. they are used when building the stage 2 compiler). They populate the libraries/ directory of a GHC tree.
     22== Repository locations ==
    23 ||||
    24 ||||
    25 ||||
    26 ||||
    27 ||||
    28 ||||
    29 ||||
    30 ||||
    31 ||||
    32 ||||
    33 ||||
    34 ||||
    35 ||||
    36 ||||
    37 ||||
    38 ||||
    39 ||||
    40 ||||
    41 ||||
     24Many of the libraries and tools in a GHC tree are actually maintained by someone else. They therefore have a separate upstream repository, from which we need to pull. That repository may be either a darcs or a git repository; in the darcs case, we also need to convert to a git repository for use in a GHC tree. However, if the darcs repository is on another server, then we first need to mirror it for the conversion program to use. This diagram shows how changes migrate from one repo to another:
    43 Additionally a GHC build needs these two tools:
    45 ||||
    46 ||||
     28This means that when making changes needed in GHC to one of these libraries, we first need to put the changes in the upstream repository. For example, to make a change to Cabal:
     30 * First push the change as a darcs patch to the upstream Cabal repository,
     31 * The patch will be mirrored and converted to git by the mirror script, in the repo
     32 * You then need to pull from into `libraries/Cabal` in a regular GHC tree, validate, and push to the GHC Cabal repo,
     37<p>This table shows, for each repository in a GHC tree, where the <span style="color: green;">central repository</span> is, and what mirrors there are.</p>
     39<table border="2">
     40<tr><td colspan="2">darcs</td><td colspan="4">git</td><td></td></tr>
     41<tr><td>darcs upstream</td><td>darcs mirror</td><td>git upstream</td><td>git mirror</td><td>ghc (validated) repo</td><td>in-tree</td><td></td></tr>
     42<tr><td></td><td></td><td></td><td></td><td style="color: green;"></td><td>.</td><td rowspan="33">ghc</td></tr>
     43<tr><td></td><td></td><td></td><td></td><td style="color: green;"></td><td>ghc-tarballs</td></tr>
     44<tr><td></td><td></td><td></td><td></td><td style="color: green;"></td><td>utils/hsc2hs</td></tr>
     45<tr><td></td><td></td><td></td><td></td><td style="color: green;"></td><td>utils/haddock</td></tr>
     46<tr><td></td><td></td><td></td><td></td><td style="color: green;"></td><td>libraries/array</td></tr>
     47<tr><td></td><td></td><td></td><td></td><td style="color: green;"></td><td>libraries/base</td></tr>
     48<tr><td></td><td></td><td style="color: green;">git://</td><td></td><td></td><td>libraries/binary</td></tr>
     49<tr><td style="color: green;"></td><td></td><td></td><td></td><td></td><td>libraries/bytestring</td></tr>
     50<tr><td style="color: green;"></td><td></td><td></td><td></td><td></td><td>libraries/Cabal</td></tr>
     51<tr><td></td><td></td><td style="color: green;">git://</td><td></td><td></td><td>libraries/containers</td></tr>
     52<tr><td></td><td></td><td></td><td></td><td style="color: green;"></td><td>libraries/directory</td></tr>
     53<tr><td></td><td></td><td></td><td></td><td style="color: green;"></td><td>libraries/extensible-exceptions</td></tr>
     54<tr><td></td><td></td><td></td><td></td><td style="color: green;"></td><td>libraries/filepath</td></tr>
     55<tr><td></td><td></td><td></td><td></td><td style="color: green;"></td><td>libraries/ghc-prim</td></tr>
     56<tr><td style="color: green;"></td><td></td><td></td><td></td><td></td><td>libraries/haskeline</td></tr>
     57<tr><td></td><td></td><td></td><td></td><td style="color: green;"></td><td>libraries/haskell98</td></tr>
     58<tr><td></td><td></td><td></td><td></td><td style="color: green;"></td><td>libraries/haskell2010</td></tr>
     59<tr><td></td><td></td><td style="color: green;">git://</td><td></td><td></td><td>libraries/hoopl</td></tr>
     60<tr><td></td><td></td><td></td><td></td><td style="color: green;"></td><td>libraries/hpc</td></tr>
     61<tr><td></td><td></td><td></td><td></td><td style="color: green;"></td><td>libraries/integer-gmp</td></tr>
     62<tr><td></td><td></td><td></td><td></td><td style="color: green;"></td><td>libraries/integer-simple</td></tr>
     63<tr><td></td><td></td><td></td><td></td><td style="color: green;"></td><td>libraries/mtl</td></tr>
     64<tr><td></td><td></td><td></td><td></td><td style="color: green;"></td><td>libraries/old-locale</td></tr>
     65<tr><td></td><td></td><td></td><td></td><td style="color: green;"></td><td>libraries/old-time</td></tr>
     66<tr><td></td><td></td><td style="color: green;">git://</td><td></td><td></td><td>libraries/pretty</td></tr>
     67<tr><td></td><td></td><td></td><td></td><td style="color: green;"></td><td>libraries/process</td></tr>
     68<tr><td></td><td></td><td style="color: green;">git://</td><td></td><td></td><td>libraries/random</td></tr>
     69<tr><td></td><td></td><td></td><td></td><td style="color: green;"></td><td>libraries/template-haskell</td></tr>
     70<tr><td style="color: green;"></td><td></td><td></td><td></td><td></td><td>libraries/terminfo</td></tr>
     71<tr><td></td><td></td><td></td><td></td><td style="color: green;"></td><td>libraries/unix</td></tr>
     72<tr><td></td><td></td><td style="color: green;"></td><td></td><td></td><td>libraries/utf8-string</td></tr>
     73<tr><td></td><td></td><td></td><td></td><td style="color: green;"></td><td>libraries/Win32</td></tr>
     74<tr><td style="color: green;"></td><td></td><td></td><td></td><td></td><td>libraries/xhtml</td></tr>
     75<tr><td></td><td></td><td></td><td></td><td style="color: green;"></td><td>testsuite</td><td>testsuite</td></tr>
     76<tr><td></td><td></td><td></td><td></td><td style="color: green;"></td><td>nofib</td><td>nofib</td></tr>
     77<tr><td style="color: green;"></td><td></td><td></td><td></td><td></td><td>libraries/primitive</td><td rowspan="3">dph</td></tr>
     78<tr><td style="color: green;"></td><td></td><td></td><td></td><td></td><td>libraries/vector</td></tr>
     79<tr><td></td><td></td><td></td><td></td><td style="color: green;"></td><td>libraries/dph</td></tr>
     80<tr><td></td><td></td><td></td><td></td><td style="color: green;"></td><td>libraries/deepseq</td><td rowspan="3">extra</td></tr>
     81<tr><td></td><td></td><td></td><td></td><td style="color: green;"></td><td>libraries/parallel</td></tr>
     82<tr><td></td><td></td><td></td><td></td><td style="color: green;"></td><td>libraries/stm</td></tr>
     86== Mirroring new packages to !GitHub ==
     88Currently, 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 and ask them to do it. Currently there is no way to administer this ourselves.
    4890== Branches ==