mention 'make {html,ps,pdf}'
[ghc-hetmet.git] / MAKEHELP
1
2 Using the GHC build system
3 --------------------------
4
5 For a "Getting Started" guide, see:
6
7   http://hackage.haskell.org/trac/ghc/wiki/Building/Hacking
8
9 Common commands:
10
11   make
12
13      Builds everything: ghc stages 1 and 2, all libraries and tools.
14
15   make -j2
16
17      Parallel build: runs up to 2 commands at a time (use the number of
18      CPUs in your machine in place of '2')
19
20   cd <dir>; make
21
22      Builds everything in the given directory.
23
24   cd compiler; make 2
25
26      Make just the stage2 compiler, ignoring dependencies.  Also "make 1" to
27      build just the stage1 compiler.
28
29   cd libraries; make 1
30
31      Build just those libraries that are built by stage1 (omit the "1" to build
32      all libraries, but that will also update the stage2 compiler).
33
34   make html
35   make pdf
36   make ps
37
38      Make documentation
39
40   make install
41
42      Installs GHC, libraries and tools under $(prefix)
43
44   make sdist
45   make binary-dist
46
47      Builds a source or binary distribution respectively
48
49   make show VALUE=<var>
50
51      Displays the value of make variable <var>
52
53   make clean
54   make distclean
55   make maintainer-clean
56
57      Various levels of cleaning: "clean" restores the tree to the
58      state after "./configure", "distclean" restores to the state
59      after "sh boot", and maintainer-clean restores the tree to the
60      completely clean checked-out state.
61