Changes between Version 16 and Version 17 of GhcDarcs


Ignore:
Timestamp:
Sep 11, 2006 1:24:41 PM (8 years ago)
Author:
simonmar
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • GhcDarcs

    v16 v17  
    1 === Getting a GHC source tree === 
    2  
    3 The first thing to do is install [http://darcs.net/ darcs]. 
    4  
    5 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: 
    6  
    7 {{{ 
    8   $ darcs get --partial http://darcs.haskell.org/ghc 
    9   $ cd ghc 
    10   $ chmod +x darcs-all 
    11   $ ./darcs-all get 
    12 }}} 
    13  
    14 '''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. 
    15  
    16 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: 
    17  
    18 {{{ 
    19   $ ./darcs-all --extra get 
    20 }}} 
    21  
    22 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. 
    23  
    24 Optionally, you might want to grab the testsuite and benchmark suite too, which should also be sub-directories of ghc: 
    25  
    26 {{{ 
    27   $ darcs get --partial http://darcs.haskell.org/testsuite 
    28   $ darcs get --partial http://darcs.haskell.org/nofib 
    29 }}} 
    30  
    31 == List of repositories == 
    32  
    33 These darcs repositories are related to GHC: 
    34  
    35 ||[http://darcs.haskell.org/ghc]||The main GHC repository|| 
    36 ||[http://darcs.haskell.org/testsuite]||The test suite (requires python 2.4+) || 
    37 ||[http://darcs.haskell.org/nofib]||The benchmark suite|| 
    38  
    39 The following repositories are the "core" packages, that populate the libraries directory of a GHC tree: 
    40  
    41 ||http://darcs.haskell.org/packages/base|| 
    42 ||http://darcs.haskell.org/packages/Cabal|| 
    43 ||http://darcs.haskell.org/packages/haskell98|| 
    44 ||http://darcs.haskell.org/packages/readline|| 
    45 ||http://darcs.haskell.org/packages/regex-base|| 
    46 ||http://darcs.haskell.org/packages/regex-posix|| 
    47 ||http://darcs.haskell.org/packages/regex-compat|| 
    48 ||http://darcs.haskell.org/packages/stm|| 
    49 ||http://darcs.haskell.org/packages/template-haskell|| 
    50 ||http://darcs.haskell.org/packages/unix|| 
    51 ||http://darcs.haskell.org/packages/Win32|| 
    52  
    53 And the following repositories are the "extra" packages: 
    54  
    55 ||http://darcs.haskell.org/packages/ALUT|| 
    56 ||http://darcs.haskell.org/packages/GLUT|| 
    57 ||http://darcs.haskell.org/packages/HGL|| 
    58 ||http://darcs.haskell.org/packages/HUnit|| 
    59 ||http://darcs.haskell.org/packages/HaXml|| 
    60 ||http://darcs.haskell.org/packages/Japi|| 
    61 ||http://darcs.haskell.org/packages/ObjectIO|| 
    62 ||http://darcs.haskell.org/packages/OpenAL|| 
    63 ||http://darcs.haskell.org/packages/OpenGL|| 
    64 ||http://darcs.haskell.org/packages/QuickCheck|| 
    65 ||http://darcs.haskell.org/packages/X11|| 
    66 ||http://darcs.haskell.org/packages/arrows|| 
    67 ||http://darcs.haskell.org/packages/fgl|| 
    68 ||http://darcs.haskell.org/packages/haskell-src|| 
    69 ||http://darcs.haskell.org/packages/html|| 
    70 ||http://darcs.haskell.org/packages/monads|| 
    71 ||http://darcs.haskell.org/packages/mtl|| 
    72 ||http://darcs.haskell.org/packages/network|| 
    73 ||http://darcs.haskell.org/packages/parsec|| 
    74 ||http://darcs.haskell.org/packages/time|| 
    75 ||http://darcs.haskell.org/packages/xhtml|| 
    76  
    77 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. 
    78  
    79  
    80 === Pulling new patches === 
    81  
    82 To update your tree from the master repositories, the quickest way is to use the {{{darcs-all}}} script: 
    83  
    84 {{{ 
    85   $ ./darcs-all pull -a 
    86 }}} 
    87  
    88 === Submitting patches === 
    89  
    90 To submit patches to the developers, please use {{{darcs send}}}.  You don't need any special permission to do this. 
    91  
    92 === Committing changes === 
    93  
    94 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. 
    95  
    96 {{{ 
    97   $ darcs push <account>@darcs.haskell.org:/home/darcs/ghc 
    98 }}} 
    99  
    100 (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}}}. 
    101  
    102 Do not forget to {{{darcs record}}} your changes first! 
    103  
    104 Please test changes before committing: you can run a cut-down version of the full test suite like this: 
    105  
    106 {{{ 
    107   $ cd testsuite 
    108   $ make boot 
    109   $ cd tests/ghc-regress 
    110   $ make fast 
    111 }}} 
    112  
    113 You need to have {{{testsuite}}} checked out, of course.  Running {{{make fast}}} should only take a few minutes. 
    114  
     1[[redirect(wiki:Building/GettingTheSources)]]