Finalise documentation build rule (#447)
[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) [![OS X status](https://img.shields.io/circleci/project/github/snowleopard/hadrian.svg?label=OS%20X)](https://circleci.com/gh/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 soon 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. the resulting GHC is `inplace/bin/ghc-stage2`.
15
16 Your first build
17 ----------------
18
19 Beware, the build system is in the alpha development phase. Things are shaky and sometimes
20 break; there are numerous [known issues][issues]. Not afraid? Then put on the helmet and
21 run the following command from root of the GHC tree:
22
23 ```
24 hadrian/build.sh -j
25 ```
26
27 or on Windows:
28
29 ```
30 hadrian/build.bat -j
31 ```
32
33 Here flag `-j` enables parallelism and is optional. We will further refer to the build script
34 simply as `build`. Note that Hadrian runs the `boot` and `configure` scripts automatically when
35 needed. Use `--skip-configure` to suppress this behaviour (see the overview of command line
36 flags below).
37
38 Notes:
39
40 * If the default build script doesn't work, you might want to give a try to another one, e.g. based
41 on Cabal sandboxes (`build.cabal.*`), Stack (`build.stack.*`) or the global package database
42 (`build.global-db.*`). Also see [instructions for building GHC on Windows using Stack][windows-build].
43
44 * Hadrian is written in Haskell and depends on the following packages:
45 `ansi-terminal extra mtl quickcheck shake`.
46
47 * If you have never built GHC before, start with the [preparation guide][ghc-preparation].
48
49 Using the build system
50 ----------------------
51 Once your first build is successful, simply run `build` to rebuild. Build results
52 are placed into `_build` and `inplace` directories.
53
54 #### Command line flags
55
56 In addition to standard Shake flags (try `--help`), the build system
57 currently supports several others:
58 * `--flavour=FLAVOUR`: choose a build flavour. The following settings are currently supported:
59 `default`, `quick`, `quickest`, `perf`, `prof`, `devel1` and `devel2`. As an example, the
60 `quickest` flavour adds `-O0` flag to all GHC invocations and builds libraries only in the
61 `vanilla` way, which speeds up builds by 3-4x. Build flavours are documented
62 [here](https://github.com/snowleopard/hadrian/blob/master/doc/flavours.md).
63
64 * `--freeze1`: freeze Stage1 GHC, i.e. do not rebuild it even if some of its source files
65 are out-of-date. This allows to significantly reduce the rebuild time when you are working
66 on a feature that affects both Stage1 and Stage2 compilers, but may lead to incorrect
67 build results. To unfreeze Stage1 GHC simply drop the `--freeze1` flag and Hadrian will
68 rebuild all out-of-date files.
69
70 * `--integer-simple`: build GHC using the `integer-simple` integer library (instead
71 of `integer-gmp`).
72
73 * `--progress-colour=MODE`: choose whether to use colours when printing build progress
74 info. There are three settings: `never` (do not use colours), `auto` (attempt to detect
75 whether the console supports colours; this is the default setting), and `always` (use
76 colours).
77
78 * `--progress-info=STYLE`: choose how build progress info is printed. There are four
79 settings: `none`, `brief` (one line per build command; this is the default setting),
80 `normal` (typically a box per build command), and `unicorn` (when `normal` just won't do).
81
82 * `--skip-configure`: use this flag to suppress the default behaviour of Hadrian that
83 runs the `boot` and `configure` scripts automatically when needed, so that you don't have
84 to remember to run them manually. With `--skip-configure` you will need to manually run:
85     ```bash
86     ./boot
87     ./configure # On Windows run ./configure --enable-tarballs-autodownload
88     ```
89     as you normally do when using `make`. Beware, by default Hadrian may do network I/O on
90 Windows to download necessary tarballs, which may sometimes be undesirable; `--skip-configure`
91 is your friend in such cases.
92
93 * `--split-objects`: generate split objects, which are switched off by default. Due to
94 a GHC [bug][ghc-split-objs-bug], you need a full clean rebuild when using this flag.
95
96 * `--verbose`: run Hadrian in verbose mode. In particular this prints diagnostic messages
97 by Shake oracles.
98
99 #### User settings
100
101 The Make-based build system uses `mk/build.mk` to specify user build settings. We
102 use `hadrian/UserSettings.hs` for the same purpose, see [documentation](doc/user-settings.md).
103
104 #### Clean and full rebuild
105
106 * `build clean` removes all build artefacts.
107
108 * `build -B` forces Shake to rerun all rules, even if the previous build results are
109 are still up-to-date.
110
111 #### Documentation
112
113 To build GHC documentation, run `build docs`. Note that finer-grain documentation
114 targets (e.g. building only HTML documentation or only the GHC User's Guide)
115 are currently not supported.
116
117 #### Source distribution
118
119 To build a GHC source distribution tarball, run `build sdist-ghc`.
120
121 #### Installation
122
123 To build and install GHC artifacts, run `build install`.
124
125 By default, GHC will be installed to the specified _prefix_ path on your system,
126 relative to the root of the file system. For example on UNIX, GHC will be installed
127 to `/usr/local/bin`. By setting the command line flag `--install-destdir=[DESTDIR]`,
128 you can install GHC to path `DESTDIR/<prefix>` instead. Make sure you use correct
129 absolute path as `DESTDIR` on Windows, e.g. `C:/path`, which installs GHC
130 into `C:/path/usr/local`.
131
132 #### Testing
133
134 * `build validate` runs GHC tests by simply executing `make fast` in `testsuite/tests`
135 directory. This can be used instead of `sh validate --fast --no-clean` in the existing
136 build system. Note: this will rebuild Stage2 GHC, `ghc-pkg` and `hpc` if they are out of date.
137
138 * `build test` runs GHC tests by calling the `testsuite/driver/runtests.py` python
139 script with appropriate flags. The current implementation is limited and cannot
140 replace the `validate` script (see [#187][validation-issue]).
141
142 * `build selftest` runs tests of the build system. Current test coverage is close to
143 zero (see [#197][test-issue]).
144
145 Current limitations
146 -------------------
147 The new build system still lacks many important features:
148 * Validation is not implemented: [#187][validation-issue].
149 * Dynamic linking on Windows is not supported [#343][dynamic-windows-issue].
150 * There is no support for binary distribution: [#219][bin-dist-issue].
151
152 Check out [milestones] to see when we hope to resolve the above limitations.
153
154 How to contribute
155 -----------------
156
157 The best way to contribute is to try the new build system, report the issues
158 you found, and attempt to fix them. Please note: the codebase is very unstable
159 at present and we expect a lot of further refactoring. If you would like to
160 work on a particular issue, please let everyone know by adding a comment about
161 this. The issues that are currently on the critical path and therefore require
162 particular attention are listed in [#239](https://github.com/snowleopard/hadrian/issues/239).
163 Also have a look at [projects](https://github.com/snowleopard/hadrian/projects)
164 where open issues and pull requests are grouped into categories.
165
166 Acknowledgements
167 ----------------
168
169 I started this project as part of my 6-month research visit to Microsoft
170 Research Cambridge, which was funded by Newcastle University, EPSRC, and
171 Microsoft Research. I would like to thank Simon Peyton Jones, Neil Mitchell
172 and Simon Marlow for kick-starting the project and for their guidance.
173 Zhen Zhang has done fantastic work on Hadrian as part of his Summer of
174 Haskell 2017 [project](https://summer.haskell.org/ideas.html#hadrian-ghc),
175 solving a few heavy and long-overdue issues. Last but not least, big thanks
176 to all other project [contributors][contributors], who helped me endure and
177 enjoy the project.
178
179 [ghc]: https://en.wikipedia.org/wiki/Glasgow_Haskell_Compiler
180 [shake]: https://github.com/ndmitchell/shake
181 [make]: https://ghc.haskell.org/trac/ghc/wiki/Building/Architecture
182 [paper]: https://www.staff.ncl.ac.uk/andrey.mokhov/Hadrian.pdf
183 [talk]: https://skillsmatter.com/skillscasts/8722-meet-hadrian-a-new-build-system-for-ghc
184 [issues]: https://github.com/snowleopard/hadrian/issues
185 [ghc-preparation]: https://ghc.haskell.org/trac/ghc/wiki/Building/Preparation
186 [ghc-windows-quick-build]: https://ghc.haskell.org/trac/ghc/wiki/Building/Preparation/Windows#AQuickBuild
187 [windows-build]: https://github.com/snowleopard/hadrian/blob/master/doc/windows.md
188 [ghc-split-objs-bug]: https://ghc.haskell.org/trac/ghc/ticket/11315
189 [test-issue]: https://github.com/snowleopard/hadrian/issues/197
190 [validation-issue]: https://github.com/snowleopard/hadrian/issues/187
191 [dynamic-windows-issue]: https://github.com/snowleopard/hadrian/issues/343
192 [bin-dist-issue]: https://github.com/snowleopard/hadrian/issues/219
193 [milestones]: https://github.com/snowleopard/hadrian/milestones
194 [contributors]: https://github.com/snowleopard/hadrian/graphs/contributors