Add a link to the user settings doc
[hadrian.git] / README.md
1 Hadrian
2 =======
3
4 [![Linux & OS X status](https://img.shields.io/travis/snowleopard/hadrian/master.svg?label=Linux%20%26%20OS%20X)](https://travis-ci.org/snowleopard/hadrian) [![Windows status](https://img.shields.io/appveyor/ci/snowleopard/hadrian/master.svg?label=Windows)](https://ci.appveyor.com/project/snowleopard/hadrian)
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. It is important for the build system to be in the `hadrian` directory
29 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     ```
36     
37 * Build GHC using `hadrian/build.sh` or `hadrian/build.bat` (on Windows) instead
38 of `make`. You might want to enable parallelism with `-j`. We will further refer to the
39 build script simply as `build`. If you are interested in building in a Cabal sandbox
40 or using Stack, have a look at `build.cabal.sh` and `build.stack.sh` scripts. Also
41 see [instructions for building GHC on Windows using Stack][windows-build]. Note, Hadrian
42 runs the `boot` and `configure` scripts automatically on the first build, so that you don't
43 need to. Use `--skip-configure` to suppress this behaviour (see overview of command line
44 flags below).
45
46 Using the build system
47 ----------------------
48 Once your first build is successful, simply run `build` to rebuild. Most build artefacts
49 are placed into `_build` and `inplace` directories ([#113][build-artefacts-issue]).
50
51 #### Command line flags
52
53 In addition to standard Shake flags (try `--help`), the build system
54 currently supports several others:
55 * `--flavour=FLAVOUR`: choose a build flavour. Two settings are currently supported:
56 `default` and `quick` (adds `-O0` flag to all GHC invocations and disables library
57 profiling, which speeds up builds by 3-4x).
58
59 * `--haddock`: build Haddock documentation.
60
61 * `--progress-info=STYLE`: choose how build progress info is printed. There are four
62 settings: `none`, `brief` (one line per build command), `normal` (typically a box per
63 build command; this is the default setting), and `unicorn` (when `normal` just won't do).
64
65 * `--skip-configure`: use this flag to suppress the default behaviour of Hadrian that
66 runs the `boot` and `configure` scripts automatically if need be, so that you don't have
67 to remember to run them manually. With `--skip-configure` you will need to manually run:
68
69     ```bash
70     ./boot
71     ./configure # On Windows run ./configure --enable-tarballs-autodownload
72     ```
73 as you normally do when using `make`. Beware, by default Hadrian may do network I/O on
74 Windows to download necessary tarballs, which may sometimes be undesirable; `--skip-configure`
75 is your friend in such cases.
76
77 * `--split-objects`: generate split objects, which are switched off by default. Due to
78 a GHC [bug][ghc-split-objs-bug], you need a full clean rebuild when using this flag.
79
80 #### User settings
81
82 The `make`-based build system uses `mk/build.mk` to specify user build settings. We
83 use [`src/Settings/User.hs`][user-settings] for the same purpose, see
84 [documentation](doc/user-settings.md).
85
86 #### Clean and full rebuild
87
88 * `build clean` removes all build artefacts. Note, we are working towards a
89 complete separation of GHC sources and build artefacts: [#113][build-artefacts-issue].
90
91 * `build -B` forces Shake to rerun all rules, even if results of the previous build
92 are still in the GHC tree. 
93
94 #### Testing
95
96 * `build validate` runs GHC tests by simply executing `make fast` in `testsuite/tests`
97 directory. This can be used instead of `sh validate --fast --no-clean` in the existing
98 build system. Note: this will rebuild Stage2 GHC, `ghc-pkg` and `hpc` if they are out of date.
99
100 * `build test` runs GHC tests by calling the `testsuite/driver/runtests.py` python
101 script with appropriate flags. The current implementation is limited and cannot
102 replace the `validate` script (see [#187][validation-issue]).
103
104 * `build selftest` runs tests of the build system. Current test coverage is close to
105 zero (see [#197][test-issue]).
106
107 Current limitations
108 -------------------
109 The new build system still lacks many important features:
110 * We only build `vanilla` and `profiling` way: [#4][dynamic-issue].
111 * Validation is not implemented: [#187][validation-issue].
112 * Only HTML Haddock documentation is supported (use `--haddock` flag). 
113 * Build flavours and conventional command line flags are not implemented: [#188][flavours-issue].
114 * Cross-compilation is not implemented: [#177][cross-compilation-issue].
115 * There is no support for installation or binary/source distribution: [#219][install-issue].
116
117 Check out [milestones] to see when we hope to resolve the above limitations.
118
119 How to contribute
120 -----------------
121
122 The best way to contribute is to try the new build system, report the issues
123 you found, and attempt to fix them. Please note the codebase is very unstable
124 at present and we expect a lot of further refactoring. The documentation is
125 currently non-existent, but we are working on it: [#55][comments-issue],
126 [#56][doc-issue]. See also [#239](https://github.com/snowleopard/hadrian/issues/239)
127 for a list of issues on the critical path.
128
129 Acknowledgements
130 ----------------
131
132 I started this project as part of my 6-month research visit to Microsoft
133 Research Cambridge, which was funded by Newcastle University, EPSRC, and
134 Microsoft Research. I would like to thank Simon Peyton Jones, Neil Mitchell
135 and Simon Marlow for kick-starting the project and for their guidance. Last
136 but not least, big thanks to the project [contributors][contributors], who
137 helped me endure and enjoy the project.
138
139 [ghc]: https://en.wikipedia.org/wiki/Glasgow_Haskell_Compiler
140 [shake]: https://github.com/ndmitchell/shake/blob/master/README.md
141 [make]: https://ghc.haskell.org/trac/ghc/wiki/Building/Architecture
142 [ghc-shake-wiki]: https://ghc.haskell.org/trac/ghc/wiki/Building/Shake
143 [blog-post-1]: https://blogs.ncl.ac.uk/andreymokhov/shaking-up-ghc
144 [issues]: https://github.com/snowleopard/hadrian/issues
145 [ghc-preparation]: https://ghc.haskell.org/trac/ghc/wiki/Building/Preparation
146 [ghc-windows-quick-build]: https://ghc.haskell.org/trac/ghc/wiki/Building/Preparation/Windows#AQuickBuild
147 [windows-build]: https://github.com/snowleopard/hadrian/blob/master/doc/windows.md
148 [build-artefacts-issue]: https://github.com/snowleopard/hadrian/issues/113
149 [ghc-split-objs-bug]: https://ghc.haskell.org/trac/ghc/ticket/11315
150 [user-settings]: https://github.com/snowleopard/hadrian/blob/master/src/Settings/User.hs
151 [test-issue]: https://github.com/snowleopard/hadrian/issues/197
152 [dynamic-issue]: https://github.com/snowleopard/hadrian/issues/4
153 [validation-issue]: https://github.com/snowleopard/hadrian/issues/187
154 [flavours-issue]: https://github.com/snowleopard/hadrian/issues/188
155 [cross-compilation-issue]: https://github.com/snowleopard/hadrian/issues/177
156 [install-issue]: https://github.com/snowleopard/hadrian/issues/219
157 [milestones]: https://github.com/snowleopard/hadrian/milestones
158 [comments-issue]: https://github.com/snowleopard/hadrian/issues/55
159 [doc-issue]: https://github.com/snowleopard/hadrian/issues/56
160 [contributors]: https://github.com/snowleopard/hadrian/graphs/contributors