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