Add tests for #8128 and #8740
[ghc.git] / INSTALL.md
1 Building & Installing
2 =====================
3
4 For full information on building GHC, see the GHC Building Guide [1].
5 Here follows a summary - if you get into trouble, the Building Guide
6 has all the answers.
7
8 Before building GHC you may need to install some other tools and
9 libraries.  See "Setting up your system for building GHC" [2].
10
11 N.B. in particular you need GHC installed in order to build GHC,
12 because the compiler is itself written in Haskell.  For instructions
13 on how to port GHC to a new platform, see the Building Guide [1].
14
15 For building library documentation, you'll need Haddock [3].  To build
16 the compiler documentation, you need [Sphinx](http://www.sphinx-doc.org/) and
17 XeLaTex (only for PDF output).
18
19 Quick start:  the following gives you a default build:
20
21     $ python3 boot
22     $ ./configure
23     $ make
24     $ make install
25
26   On Windows, you need an extra repository containing some build tools.
27   These can be downloaded for you by configure. This only needs to be done once by running:
28
29     $ ./configure --enable-tarballs-autodownload
30
31 You can use Make's `-jN` option to parallelize the build. It's generally best
32 to set `N` somewhere around the core count of the build machine.
33
34 The `python3 boot` step is only necessary if this is a tree checked out from
35 git. For source distributions downloaded from GHC's web site, this step has
36 already been performed.
37
38 These steps give you the default build, which includes everything
39 optimised and built in various ways (eg. profiling libs are built).
40 It can take a long time.  To customise the build, see the file
41 `HACKING.md`.
42
43 References
44 ==========
45
46  [1] http://www.haskell.org/ghc/
47  [2] http://hackage.haskell.org/trac/ghc/wiki/Building/Preparation
48  [3] http://www.haskell.org/haddock/