HACKING

   1 Getting started with hacking on GHC
   2 -----------------------------------
   3
   4 So you've decided to hack on GHC, congratulations!  We hope you have a
   5 rewarding experience.  This file will point you in the direction of
   6 information to help you get started right away.
   7
   8
   9 The GHC Developer's Wiki
  10 ------------------------
  11
  12   The home for GHC Developers, with information on accessing the
  13   latest sources, the bug tracker, and documentation on the
  14   code:
  15
  16   http://hackage.haskell.org/trac/ghc
  17
  18   In particular, the wiki contains the following pages of interest to
  19   new hackers:
  20
  21   Quick Start for developers
  22
  23      http://hackage.haskell.org/trac/ghc/wiki/Building/Hacking
  24
  25      This section on the wiki will get you up and running with a
  26      serviceable build tree in no time.
  27
  28      Don't skip this!  By default, GHC builds with all optimizations
  29      and profiling; most hackers will want a quicker build, so creating
  30      a mk/build.mk file and knowing how to rebuild only parts of GHC is
  31      very important.
  32
  33      This is part of the "Building GHC" section of the wiki, which
  34      has more detailed information on GHC's build system should you
  35      need it.
  36
  37
  38   Coding conventions
  39
  40      http://hackage.haskell.org/trac/ghc/wiki/WorkingConventions
  41
  42      This wiki page explains the ground rules for code that is intended
  43      to go into the mainline compiler source.
  44
  45
  46   The GHC Commentary
  47
  48      http://hackage.haskell.org/trac/ghc/wiki/Commentary
  49
  50      Notes on the internals and architecture of GHC.
  51
  52
  53 Mailing lists
  54 -------------
  55
  56    Ask on glasgow-haskell-users@haskell.org if you have difficulties.
  57    If you're working with the current darcs sources of GHC, then
  58    cvs-ghc@haskell.org might be a more appropriate (developers hang
  59    out here).  See http://www.haskell.org/mailman/listinfo for
  60    subscription.
  61
  62
  63 Happy Hacking!  --The GHC Team