Make Brief the default setting of the --progress-info flag
[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 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 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`. 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 * `--freeze1`: freeze Stage1 GHC, i.e. do not rebuild it even if some of its source files
62 are out-of-date. This allows to significantly reduce the rebuild time when you are working
63 on a feature that affects both Stage1 and Stage2 compilers, but may lead to incorrect
64 build results. To unfreeze Stage1 GHC simply drop the `--freeze1` flag and Hadrian will
65 rebuild all out-of-date files.
66
67 * `--haddock`: build Haddock documentation.
68
69 * `--integer-simple`: build GHC using the `integer-simple` integer library (instead
70 of `integer-gmp`).
71
72 * `--progress-colour=MODE`: choose whether to use colours when printing build progress
73 info. There are three settings: `never` (do not use colours), `auto` (attempt to detect
74 whether the console supports colours; this is the default setting), and `always` (use
75 colours).
76
77 * `--progress-info=STYLE`: choose how build progress info is printed. There are four
78 settings: `none`, `brief` (one line per build command; this is the default setting),
79 `normal` (typically a box per build command), and `unicorn` (when `normal` just won't do).
80
81 * `--skip-configure`: use this flag to suppress the default behaviour of Hadrian that
82 runs the `boot` and `configure` scripts automatically if need be, so that you don't have
83 to remember to run them manually. With `--skip-configure` you will need to manually run:
84
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 #### Source distribution
112
113 To build a GHC source distribution tarball, run Hadrian with the `sdist-ghc` target.
114
115 #### Installation
116
117 To build and install GHC artifacts, run the `install` target.
118
119 By default, the artifacts will be installed to `<prefix>` on your system
120 (in this case, the `DESTDIR` is empty, corresponds to the root of the file system).
121 For example on UNIX, `ghc` will be installed to `/usr/local/bin`. By setting flag `--install-destdir=[DESTDIR]`,
122 you can install things to non-system path `DESTDIR/<prefix>` instead.
123 Make sure you use correct absolute path on Windows, e.g. `C:/path`,
124 i.e. GHC is installed into `C:/path/usr/local` for the above example.
125
126 #### Testing
127
128 * `build validate` runs GHC tests by simply executing `make fast` in `testsuite/tests`
129 directory. This can be used instead of `sh validate --fast --no-clean` in the existing
130 build system. Note: this will rebuild Stage2 GHC, `ghc-pkg` and `hpc` if they are out of date.
131
132 * `build test` runs GHC tests by calling the `testsuite/driver/runtests.py` python
133 script with appropriate flags. The current implementation is limited and cannot
134 replace the `validate` script (see [#187][validation-issue]).
135
136 * `build selftest` runs tests of the build system. Current test coverage is close to
137 zero (see [#197][test-issue]).
138
139 Current limitations
140 -------------------
141 The new build system still lacks many important features:
142 * Validation is not implemented: [#187][validation-issue].
143 * Dynamic linking on Windows is not supported [#343][dynamic-windows-issue].
144 * Only HTML Haddock documentation is supported (use `--haddock` flag).
145 * Cross-compilation is not implemented: [#177][cross-compilation-issue].
146 * There is no support for binary distribution: [#219][install-issue].
147
148 Check out [milestones] to see when we hope to resolve the above limitations.
149
150 How to contribute
151 -----------------
152
153 The best way to contribute is to try the new build system, report the issues
154 you found, and attempt to fix them. Please note: the codebase is very unstable
155 at present and we expect a lot of further refactoring. If you would like to
156 work on a particular issue, please let everyone know by adding a comment about
157 this. The issues that are currently on the critical path and therefore require
158 particular attention are listed in [#239](https://github.com/snowleopard/hadrian/issues/239).
159 Also have a look at [projects](https://github.com/snowleopard/hadrian/projects)
160 where open issues and pull requests are grouped into categories.
161
162 Acknowledgements
163 ----------------
164
165 I started this project as part of my 6-month research visit to Microsoft
166 Research Cambridge, which was funded by Newcastle University, EPSRC, and
167 Microsoft Research. I would like to thank Simon Peyton Jones, Neil Mitchell
168 and Simon Marlow for kick-starting the project and for their guidance.
169 Zhen Zhang has done fantastic work on Hadrian as part of his Summer of
170 Haskell 2017 [project](https://summer.haskell.org/ideas.html#hadrian-ghc),
171 solving a few heavy and long-overdue issues. Last but not least, big thanks
172 to all other project [contributors][contributors], who helped me endure and
173 enjoy the project.
174
175 [ghc]: https://en.wikipedia.org/wiki/Glasgow_Haskell_Compiler
176 [shake]: https://github.com/ndmitchell/shake/blob/master/README.md
177 [make]: https://ghc.haskell.org/trac/ghc/wiki/Building/Architecture
178 [paper]: https://www.staff.ncl.ac.uk/andrey.mokhov/Hadrian.pdf
179 [talk]: https://skillsmatter.com/skillscasts/8722-meet-hadrian-a-new-build-system-for-ghc
180 [issues]: https://github.com/snowleopard/hadrian/issues
181 [ghc-preparation]: https://ghc.haskell.org/trac/ghc/wiki/Building/Preparation
182 [ghc-windows-quick-build]: https://ghc.haskell.org/trac/ghc/wiki/Building/Preparation/Windows#AQuickBuild
183 [windows-build]: https://github.com/snowleopard/hadrian/blob/master/doc/windows.md
184 [ghc-split-objs-bug]: https://ghc.haskell.org/trac/ghc/ticket/11315
185 [test-issue]: https://github.com/snowleopard/hadrian/issues/197
186 [validation-issue]: https://github.com/snowleopard/hadrian/issues/187
187 [dynamic-windows-issue]: https://github.com/snowleopard/hadrian/issues/343
188 [cross-compilation-issue]: https://github.com/snowleopard/hadrian/issues/177
189 [install-issue]: https://github.com/snowleopard/hadrian/issues/219
190 [milestones]: https://github.com/snowleopard/hadrian/milestones
191 [contributors]: https://github.com/snowleopard/hadrian/graphs/contributors