Minor revision
[hadrian.git] / README.md
1 Shaking up GHC
2 ==============
3
4 [![Linux & OS X status](https://img.shields.io/travis/snowleopard/shaking-up-ghc.svg?label=Linux%20%26%20OS%20X)](https://travis-ci.org/snowleopard/shaking-up-ghc) [![Windows status](https://img.shields.io/appveyor/ci/snowleopard/shaking-up-ghc.svg?label=Windows)](https://ci.appveyor.com/project/snowleopard/shaking-up-ghc)
5
6
7 As part of my 6-month research secondment to Microsoft Research in Cambridge
8 I am taking up the challenge of migrating the current [GHC][ghc] build system
9 based on standard `make` into a new and (hopefully) better one based on
10 [Shake][shake]. If you are curious about the project you can find more details
11 on the [wiki page][ghc-shake-wiki] and in this [blog post][shake-blog-post].
12
13 This is supposed to go into the `shake-build` directory of the GHC source tree.
14
15 [Join us on #shaking-up-ghc on Freenode](irc://chat.freenode.net/#shaking-up-ghc).
16
17 Trying it
18 ---------
19
20 Please see the [Preparation][ghc-preparation] on the GHC wiki
21 for general preparation. The preparation steps for the `shake` build system are
22 identical to those for the `make` build system. This means that you don't need
23 to adjust anything if you are already familiar with building ghc using the `make`
24 build system.
25
26 Furthermore, we depend on the following packages which need to be installed:
27 `ansi-terminal`, `mtl`, `shake`, `quickcheck`.
28
29 ### Getting the source and configuring GHC
30
31 ```bash
32 git clone --recursive git://git.haskell.org/ghc.git
33 cd ghc
34 git clone git://github.com/snowleopard/shaking-up-ghc shake-build
35 ./boot
36 ./configure                                # on linux / os x
37 ./configure --enable-tarballs-autodownload # on windows
38 ```
39
40 ### Configuring the build process
41
42 `ghc` uses `mk/build.mk` to configure the build process. `shaking-up-ghc`
43 uses `src/Settings/User.hs` for build specification.
44
45 ### Building GHC using `shaking-up-ghc`
46
47 ```bash
48 ./shake-build/build.sh       # linux / os x: to run the script directly.
49 ./shake-build/build.cabal.sh # linux / os x: OR to install the build system in a Cabal sandbox and then run it.
50 shake-build/build.bat        # windows
51 ```
52
53 Also see the [Building GHC on Windows guide][ghc-windows-building-guide].
54
55 ### Resetting the build
56
57 To reset the new build system run the build script with `-B` flag. This forces Shake to rerun all rules, even if results of the previous build are still in the GHC tree. This is a temporary solution; we are working on a proper reset functionality ([#131](https://github.com/snowleopard/shaking-up-ghc/issues/131)).
58
59
60 How to contribute
61 -----------------
62
63 The best way to contribute is to try the new build system, report the issues
64 you found, and attempt to fix them. Please note the codebase is very unstable
65 at present and we expect a lot of further refactoring. Before attempting to
66 fix any issue do make sure no one else is already working on it. The
67 documentation is currently non-existent, but we will start addressing this
68 once the codebase stabilises.
69
70
71 [ghc-shake-wiki]: https://ghc.haskell.org/trac/ghc/wiki/Building/Shake
72 [ghc-preparation]: https://ghc.haskell.org/trac/ghc/wiki/Building/Preparation
73 [ghc-windows-building-guide]: https://ghc.haskell.org/trac/ghc/wiki/Building/Preparation/Windows
74 [ghc]: https://en.wikipedia.org/wiki/Glasgow_Haskell_Compiler
75 [shake-blog-post]: https://blogs.ncl.ac.uk/andreymokhov/shaking-up-ghc
76 [shake]: https://github.com/ndmitchell/shake/blob/master/README.md