Update notes on build ways and flavours
[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 behind the
9 project and the architecture of the build system you can find more details in
10 this [Haskell Symposium 2016 paper][paper] and this [Haskell eXchange 2016 talk][talk].
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. Build results
49 are placed into `_build` and `inplace` directories.
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. The following settings are currently supported:
56 `default`, `quick`, `quickest`, `perf`, `prof`, `devel1` and `devel2`. As an example, the
57 `quickest` flavour adds `-O0` flag to all GHC invocations and builds libraries only in the
58 `vanilla` way, which speeds up builds by 3-4x. Build flavours are documented
59 [here](https://github.com/snowleopard/hadrian/blob/master/doc/flavours.md).
60
61 * `--haddock`: build Haddock documentation.
62
63 * `--progress-colour=MODE`: choose whether to use colours when printing build progress
64 info. There are three settings: `never` (do not use colours), `auto` (attempt to detect
65 whether the console supports colours; this is the default setting), and `always` (use
66 colours).
67
68 * `--progress-info=STYLE`: choose how build progress info is printed. There are four
69 settings: `none`, `brief` (one line per build command), `normal` (typically a box per
70 build command; this is the default setting), and `unicorn` (when `normal` just won't do).
71
72 * `--skip-configure`: use this flag to suppress the default behaviour of Hadrian that
73 runs the `boot` and `configure` scripts automatically if need be, so that you don't have
74 to remember to run them manually. With `--skip-configure` you will need to manually run:
75
76     ```bash
77     ./boot
78     ./configure # On Windows run ./configure --enable-tarballs-autodownload
79     ```
80 as you normally do when using `make`. Beware, by default Hadrian may do network I/O on
81 Windows to download necessary tarballs, which may sometimes be undesirable; `--skip-configure`
82 is your friend in such cases.
83
84 * `--split-objects`: generate split objects, which are switched off by default. Due to
85 a GHC [bug][ghc-split-objs-bug], you need a full clean rebuild when using this flag.
86
87 * `--verbose`: run Hadrian in verbose mode. In particular this prints diagnostic messages
88 by Shake oracles.
89
90 #### User settings
91
92 The `make`-based build system uses `mk/build.mk` to specify user build settings. We
93 use `hadrian/UserSettings.hs` for the same purpose, see [documentation](doc/user-settings.md).
94
95 #### Clean and full rebuild
96
97 * `build clean` removes all build artefacts. 
98
99 * `build -B` forces Shake to rerun all rules, even if the previous build results are
100 are still up-to-date.
101
102 #### Source distribution
103
104 To build a GHC source distribution tarball, run Hadrian with the `sdist-ghc` target.
105
106 #### Testing
107
108 * `build validate` runs GHC tests by simply executing `make fast` in `testsuite/tests`
109 directory. This can be used instead of `sh validate --fast --no-clean` in the existing
110 build system. Note: this will rebuild Stage2 GHC, `ghc-pkg` and `hpc` if they are out of date.
111
112 * `build test` runs GHC tests by calling the `testsuite/driver/runtests.py` python
113 script with appropriate flags. The current implementation is limited and cannot
114 replace the `validate` script (see [#187][validation-issue]).
115
116 * `build selftest` runs tests of the build system. Current test coverage is close to
117 zero (see [#197][test-issue]).
118
119 Current limitations
120 -------------------
121 The new build system still lacks many important features:
122 * There is currently no support for the `dynamic` build way: [#4][dynamic-issue].
123 * Validation is not implemented: [#187][validation-issue].
124 * Only HTML Haddock documentation is supported (use `--haddock` flag). 
125 * Not all modes of the old build system are supported, e.g. [#250][freeze-issue].
126 * Cross-compilation is not implemented: [#177][cross-compilation-issue].
127 * There is no support for installation or binary distribution: [#219][install-issue].
128
129 Check out [milestones] to see when we hope to resolve the above limitations.
130
131 How to contribute
132 -----------------
133
134 The best way to contribute is to try the new build system, report the issues
135 you found, and attempt to fix them. Please note: the codebase is very unstable
136 at present and we expect a lot of further refactoring. If you would like to
137 work on a particular issue, please let everyone know by adding a comment about
138 this. The issues that are currently on the critical path and therefore require
139 particular attention are listed in [#239](https://github.com/snowleopard/hadrian/issues/239).
140
141 Acknowledgements
142 ----------------
143
144 I started this project as part of my 6-month research visit to Microsoft
145 Research Cambridge, which was funded by Newcastle University, EPSRC, and
146 Microsoft Research. I would like to thank Simon Peyton Jones, Neil Mitchell
147 and Simon Marlow for kick-starting the project and for their guidance. Last
148 but not least, big thanks to the project [contributors][contributors], who
149 helped me endure and enjoy the project.
150
151 [ghc]: https://en.wikipedia.org/wiki/Glasgow_Haskell_Compiler
152 [shake]: https://github.com/ndmitchell/shake/blob/master/README.md
153 [make]: https://ghc.haskell.org/trac/ghc/wiki/Building/Architecture
154 [paper]: https://www.staff.ncl.ac.uk/andrey.mokhov/Hadrian.pdf
155 [talk]: https://skillsmatter.com/skillscasts/8722-meet-hadrian-a-new-build-system-for-ghc
156 [issues]: https://github.com/snowleopard/hadrian/issues
157 [ghc-preparation]: https://ghc.haskell.org/trac/ghc/wiki/Building/Preparation
158 [ghc-windows-quick-build]: https://ghc.haskell.org/trac/ghc/wiki/Building/Preparation/Windows#AQuickBuild
159 [windows-build]: https://github.com/snowleopard/hadrian/blob/master/doc/windows.md
160 [ghc-split-objs-bug]: https://ghc.haskell.org/trac/ghc/ticket/11315
161 [test-issue]: https://github.com/snowleopard/hadrian/issues/197
162 [dynamic-issue]: https://github.com/snowleopard/hadrian/issues/4
163 [validation-issue]: https://github.com/snowleopard/hadrian/issues/187
164 [freeze-issue]: https://github.com/snowleopard/hadrian/issues/250
165 [cross-compilation-issue]: https://github.com/snowleopard/hadrian/issues/177
166 [install-issue]: https://github.com/snowleopard/hadrian/issues/219
167 [milestones]: https://github.com/snowleopard/hadrian/milestones
168 [contributors]: https://github.com/snowleopard/hadrian/graphs/contributors