HACKING.md 4.69 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12
Contributing to the Glasgow Haskell Compiler
============================================

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 hackers is our Trac instance, located here:

13
<http://ghc.haskell.org/trac/ghc>
14 15 16 17 18 19

From here, you can file bugs (or look them up,) use the wiki, view the
`git` history, among other things. Of particular note is the building
page, which has the high level overview of the build process and how
to get the source:

20
<http://ghc.haskell.org/trac/ghc/wiki/Building>
21 22 23 24 25 26 27

Contributing patches to GHC in a hurry
======================================

Make sure your system has the necessary tools to compile GHC. You can
find an overview here:

28
<http://ghc.haskell.org/trac/ghc/wiki/Building/Preparation>
29 30 31 32

Next, clone the repository and all the associated libraries:

```
thomie's avatar
thomie committed
33 34 35 36 37 38 39 40
$ git clone --recursive git://git.haskell.org/ghc.git
```

On Windows, you need an extra repository containing some build tools:

```
$ cd ghc/
$ git clone git://git.haskell.org/ghc-tarballs.git
41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81
```

First copy `mk/build.mk.sample` to `mk/build.mk` and ensure it has
your preferred build settings. (You probably want to at least set
`BuildFlavour` to `quick`):

```
$ cp mk/build.mk.sample mk/build.mk
$ ... double-check mk/build.mk ...
```

Now build. If you have multiple cores, **you should always use them to
speed up compilation**:

```
$ ./boot
$ ./configure
$ make -jN # <N> is the number of cores you have.
```

You can use the `./inplace/bin/ghc-stage2` binary to play with the
newly built compiler.

Now, hack on your copy and rebuild (with `make`) as necessary.

Then start by making your commits however you want. When you're done, you
can use `git format-patch` to create a series of `.patch` files you
can give to us. In this example, we'll assume I'm on a `bugfix` branch
and want to submit my patches:

```
$ git branch
* bugfix
  master
$ git format-patch master -o patches
...
$
```

Now create a trac ticket:

82
<http://ghc.haskell.org/trac/ghc/newticket?type=bug>
83 84 85 86 87 88 89 90 91 92

And attach the files in your `patches/` directory. Set the status from
*new* to *patch* and we'll review it as soon as we can!

Useful links:
=============

An overview of things like using git, the release process, filing bugs
and more can be located here:

93
<http://ghc.haskell.org/trac/ghc/wiki/WorkingConventions>
94 95 96

You can find our coding conventions for the compiler and RTS here:

97 98
<http://ghc.haskell.org/trac/ghc/wiki/Commentary/CodingStyle>
<http://ghc.haskell.org/trac/ghc/wiki/Commentary/Rts/Conventions>
99 100 101

A high level overview of the bug tracker:

102
<http://ghc.haskell.org/trac/ghc/wiki/WorkingConventions/BugTracker>
103 104 105 106 107

If you're going to contribute regularly, **learning how to use the
build system is important** and will save you lots of time. You should
read over this page carefully:

108
<http://ghc.haskell.org/trac/ghc/wiki/Building/Using>
109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139

How to communicate with us
==========================

GHC is a big project, so you'll surely need help. Luckily, we can
provide plenty through a variety of means!

## IRC

If you're an IRC user, be sure to drop by the official `#ghc` channel
on [freenode](http://freenode.org). Many (but not all) of the
developers and committers are actively there during a variety of
hours.

## Mailing lists

In the event IRC does not work or if you'd like a bigger audience, GHC
has several mailing lists for this purpose. The most important one is
[ghc-devs](http://www.haskell.org/pipermail/ghc-devs/), which is where
the developers actively hang out and discuss incoming changes and
problems.

There is no strict standard about where you post patches - either in
`ghc-devs` or in the bug tracker. Ideally, please put it in the bug
tracker with test cases or relevant information in a ticket, and set
the ticket status to `patch`. By doing this, we'll see the patch
quickly and be able to review. This will also ensure it doesn't get
lost. But if the change is small and self contained, feel free to
attach it to your email, and send it to `ghc-devs`.

Furthermore, if you're a developer (or want to become one!) you're
Herbert Valerio Riedel's avatar
Herbert Valerio Riedel committed
140
undoubtedly also interested in the other mailing lists:
141 142 143 144 145 146 147 148 149 150 151 152 153 154

 * [glasgow-haskell-users](http://www.haskell.org/mailman/listinfo/glasgow-haskell-users)
   is where developers/users meet.
 * [ghc-tickets](http://www.haskell.org/mailman/listinfo/ghc-tickets)
   for email from Trac.
 * [ghc-builds](http://www.haskell.org/mailman/listinfo/ghc-builds)
   for nightly build emails.
 * [ghc-commits](http://www.haskell.org/mailman/listinfo/ghc-commits)
   for commit messages when someone pushes to the repository.

El fin
======

Happy Hacking!  -- The GHC Team