Rename to Hadrian
[ghc.git] / README.md
1 Hadrian
2 =======
3
4 [![Linux & OS X status](https://img.shields.io/travis/snowleopard/shaking-up-ghc/master.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/master.svg?label=Windows)](https://ci.appveyor.com/project/snowleopard/shaking-up-ghc)
5
6 Hadrian is a new build system for the [Glasgow Haskell Compiler][ghc]. It is based
7 on [Shake][shake] and we hope that it will eventually replace the current
8 [`make`-based build system][make]. If you are curious about the rationale and initial
9 ideas behind the project you can find more details on the [wiki page][ghc-shake-wiki]
10 and in this [blog post][blog-post-1]. This project was formerly known as *Shaking-up-GHC*.
11
12 The new build system can work side-by-side with the existing build system. Note, there is
13 some interaction between them: they put (some) build results in the same directories,
14 e.g. `inplace/bin/ghc-stage1`.
15
16 Your first build
17 ----------------
18
19 Beware, the build system is in the alpha development phase. Things are shaky and often
20 break; there are numerous [known issues][issues]. Not afraid? Then put on the helmet and
21 follow these steps:
22
23 * If you have never built GHC before, start with the [preparation guide][ghc-preparation].
24
25 * This build system is written in Haskell (obviously) and depends on the following Haskell
26 packages, which need to be installed: `ansi-terminal`, `mtl`, `shake`, `QuickCheck`.
27
28 * Get the sources and run standard configuration scripts. It is important for the build
29 system to be in the `hadrian` directory of the GHC source tree:
30
31     ```bash
32     git clone --recursive git://git.haskell.org/ghc.git
33     cd ghc
34     git clone git://github.com/snowleopard/hadrian
35     ./boot
36     ./configure # On Windows run ./configure --enable-tarballs-autodownload
37     ```
38     
39 * Build GHC using `hadrian/build.sh` or `hadrian/build.bat` (on Windows) instead
40 of `make`. You might want to enable parallelism with `-j`. We will further refer to the
41 build script simply as `build`. If you are interested in building in a Cabal sandbox
42 or using Stack, have a look at `build.cabal.sh` and `build.stack.sh` scripts. Also
43 see [instructions for building GHC on Windows using Stack][windows-build].
44
45 Using the build system
46 ----------------------
47 Once your first build is successful, simply run `build` to rebuild. Most build artefacts
48 are placed into `.build` and `inplace` directories ([#113][build-artefacts-issue]).
49
50 #### Command line flags
51
52 In addition to standard Shake flags (try `--help`), the build system
53 currently supports several others:
54 * `--flavour=FLAVOUR`: choose a build flavour. Two settings are currently supported:
55 `default` and `quick` (adds `-O0` flag to all GHC invocations and disables library
56 profiling, which speeds up builds by 3-4x).
57 * `--haddock`: build Haddock documentation.
58 * `--progress-info=STYLE`: choose how build progress info is printed. There are four
59 settings: `none`, `brief` (one line per build command), `normal` (typically a box per
60 build command; this is the default setting), and `unicorn` (when `normal` just won't do).
61 * `--setup[=CONFIGURE_ARGS]`: setup the build system by running the `configure` script 
62 with `CONFIGURE_ARGS` arguments; also run the `boot` script to create the `configure`
63 script if necessary. On Windows, download the required tarballs by executing
64 `mk/get-win32-tarballs.sh` with appropriate parameters. You do not have to
65 use this functionality of the new build system; feel free to run `boot` and `configure`
66 scripts manually, as you do when using `make`. Beware: `--setup` uses network I/O 
67 which may sometimes be undesirable.
68 * `--split-objects`: generate split objects, which are switched off by default. Due to
69 a GHC [bug][ghc-split-objs-bug], you need a full clean rebuild when using this flag.
70
71 #### User settings
72
73 The `make`-based build system uses `mk/build.mk` to specify user build settings. We
74 use [`src/Settings/User.hs`][user-settings] for the same purpose. Feel free to
75 experiment following the Haddock comments.
76
77 #### Clean and full rebuild
78
79 * `build clean` removes all build artefacts. Note, we are working towards a
80 complete separation of GHC sources and build artefacts: [#113][build-artefacts-issue].
81
82 * `build -B` forces Shake to rerun all rules, even if results of the previous build
83 are still in the GHC tree. 
84
85 #### Testing
86
87 * `build validate` runs GHC tests by simply executing `make fast` in `testsuite/tests`
88 directory. This can be used instead of `sh validate --fast --no-clean` in the existing
89 build system. Note: this will rebuild Stage2 GHC, `ghc-pkg` and `hpc` if they are out of date.
90
91 * `build test` runs GHC tests by calling the `testsuite/driver/runtests.py` python
92 script with appropriate flags. The current implementation is limited and cannot
93 replace the `validate` script (see [#187][validation-issue]).
94
95 * `build selftest` runs tests of the build system. Current test coverage is close to
96 zero (see [#197][test-issue]).
97
98 Current limitations
99 -------------------
100 The new build system still lacks many important features:
101 * We only build `vanilla` and `profiling` way: [#4][dynamic-issue].
102 * Validation is not implemented: [#187][validation-issue].
103 * Only HTML Haddock documentation is supported (use `--haddock` flag). 
104 * Build flavours and conventional command line flags are not implemented: [#188][flavours-issue].
105 * Cross-compilation is not implemented: [#177][cross-compilation-issue].
106 * There is no support for installation or binary/source distribution: [#219][install-issue].
107
108 Check out [milestones] to see when we hope to resolve the above limitations.
109
110 How to contribute
111 -----------------
112
113 The best way to contribute is to try the new build system, report the issues
114 you found, and attempt to fix them. Please note the codebase is very unstable
115 at present and we expect a lot of further refactoring. The documentation is
116 currently non-existent, but we are working on it: [#55][comments-issue],
117 [#56][doc-issue].
118
119 Acknowledgements
120 ----------------
121
122 I started this project as part of my 6-month research visit to Microsoft
123 Research Cambridge, which was funded by Newcastle University, EPSRC, and
124 Microsoft Research. I would like to thank Simon Peyton Jones, Neil Mitchell
125 and Simon Marlow for kick-starting the project and for their guidance. Last
126 but not least, big thanks to the project [contributors][contributors], who
127 helped me endure and enjoy the project.
128
129 [ghc]: https://en.wikipedia.org/wiki/Glasgow_Haskell_Compiler
130 [shake]: https://github.com/ndmitchell/shake/blob/master/README.md
131 [make]: https://ghc.haskell.org/trac/ghc/wiki/Building/Architecture
132 [ghc-shake-wiki]: https://ghc.haskell.org/trac/ghc/wiki/Building/Shake
133 [blog-post-1]: https://blogs.ncl.ac.uk/andreymokhov/shaking-up-ghc
134 [issues]: https://github.com/snowleopard/hadrian/issues
135 [ghc-preparation]: https://ghc.haskell.org/trac/ghc/wiki/Building/Preparation
136 [ghc-windows-quick-build]: https://ghc.haskell.org/trac/ghc/wiki/Building/Preparation/Windows#AQuickBuild
137 [windows-build]: https://github.com/snowleopard/hadrian/blob/master/doc/windows.md
138 [build-artefacts-issue]: https://github.com/snowleopard/hadrian/issues/113
139 [ghc-split-objs-bug]: https://ghc.haskell.org/trac/ghc/ticket/11315
140 [user-settings]: https://github.com/snowleopard/hadrian/blob/master/src/Settings/User.hs
141 [test-issue]: https://github.com/snowleopard/hadrian/issues/197
142 [dynamic-issue]: https://github.com/snowleopard/hadrian/issues/4
143 [validation-issue]: https://github.com/snowleopard/hadrian/issues/187
144 [flavours-issue]: https://github.com/snowleopard/hadrian/issues/188
145 [cross-compilation-issue]: https://github.com/snowleopard/hadrian/issues/177
146 [install-issue]: https://github.com/snowleopard/hadrian/issues/219
147 [milestones]: https://github.com/snowleopard/hadrian/milestones
148 [comments-issue]: https://github.com/snowleopard/hadrian/issues/55
149 [doc-issue]: https://github.com/snowleopard/hadrian/issues/56
150 [contributors]: https://github.com/snowleopard/hadrian/graphs/contributors