summaryrefslogtreecommitdiff
path: root/HACKING
blob: a32b074ac291575af9dfc9e2ed2f180bc247886f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
Getting started with hacking on GHC
-----------------------------------

So you've decided to hack on GHC, congratulations!  We hope you have a
rewarding experience.  This file will point you in the direction of
information to help you get started right away.


The GHC Developer's Wiki
------------------------

  The home for GHC Developers, with information on accessing the
  latest sources, the bug tracker, and documentation on the
  code:
  
  http://hackage.haskell.org/trac/ghc
  
  In particular, the wiki contains the following pages of interest to
  new hackers:
  
  Quick Start for developers

     http://hackage.haskell.org/trac/ghc/wiki/Building/Hacking 
   
     This section on the wiki will get you up and running with a
     serviceable build tree in no time:
  
     This is part of the "Building GHC" section of the wiki, which
     has more detailed information on GHC's build system should you
     need it.


  Coding conventions

     http://hackage.haskell.org/trac/ghc/wiki/WorkingConventions

     This wiki page explains the ground rules for code that is intended
     to go into the mainline compiler source.
  
  
  The GHC Commentary
  
     http://hackage.haskell.org/trac/wiki/Commentary

     Notes on the internals and architecture of GHC.
     

Mailing lists
-------------

   Ask on glasgow-haskell-users@haskell.org if you have difficulties.
   If you're working with the current CVS sources of GHC, then
   cvs-ghc@haskell.org might be a more appropriate (developers hang
   out here).  See http://www.haskell.org/mailman/listinfo for
   subscription.


Happy Hacking!  --The GHC Team