ghc-hq / ghc
watch download tarball
public
Forks3Right
Watchers42Right
Description: Official Git mirror of the Glasgow Haskell Compiler. Note: Building from the Git repo is not yet possible.
Homepage: http://haskell.org/ghc/
Clone URL: git://github.com/ghc-hq/ghc.git
ghc / README
100644 116 lines (72 sloc) 3.057 kb
raw blame history 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116

The Glasgow Haskell Compiler
============================
 
This is the source tree for GHC, a compiler and interactive
environment for the Haskell functional programming language.
 
For more information, visit GHC's web site:
 
  http://www.haskell.org/ghc/
 
Information for developers of GHC can be found here:
 
  http://hackage.haskell.org/trac/ghc/
 
 
Getting the Source
==================
 
There are two ways to get a source tree:
 
  1. Download source tarballs
  ---------------------------
 
  Download the GHC source distribution:
 
      ghc-<version>-src.tar.bz2
 
  which contains GHC itself and the "boot" libraries.
 
  2. Check out the source code from darcs
  ---------------------------------------
 
  The recommended way to get a darcs checkout is to start off by
  downloading a snapshot with a name like:
 
      ghc-HEAD-2009-09-09-ghc-corelibs-testsuite.tar.bz2
 
  from:
 
      http://darcs.haskell.org/
 
  and then untar it and bring it up-to-date with:
 
     $ cd ghc
     $ ./darcs-all get
 
 
  Alternatively you can use darcs to get the repos, but it will take a
  lot longer. First get the GHC darcs repository:
 
    $ darcs get http://darcs.haskell.org/ghc/
 
  Then run the darcs-all script in that repository
  to get the other repositories:
 
     $ cd ghc
     $ chmod +x darcs-all
     $ ./darcs-all get
 
  This checks out the "boot" packages.
 
 
Building & Installing
=====================
 
For full information on building GHC, see the GHC Building Guide [3].
Here follows a summary - if you get into trouble, the Building Guide
has all the answers.
 
NB. you need GHC installed in order to build GHC, because the compiler
is itself written in Haskell.  For instructions on how to port GHC to a
new platform, see the Building Guide.
 
If you're building from darcs sources (as opposed to a source
distribution) then you also need to install Happy [4] and Alex [5].
 
For building library documentation, you'll need Haddock [6].  To build
the compiler documentation, you need a good DocBook XML toolchain and
dblatex.
 
Quick start:  the following gives you a default build:
 
    $ sh boot
    $ ./configure
    $ make
    $ make install
 
The "sh boot" step is only necessary if this is a tree checked out
from darcs.  For source distributions downloaded from GHC's web site,
this step has already been performed.
 
These steps give you the default build, which includes everything
optimised and built in various ways (eg. profiling libs are built).
It can take a long time.  To customise the build, see the file
HACKING.
 
 
 
References
==========
 
 [1] http://www.haskell.org/ghc/                        GHC Home Page
 [2] http://hackage.haskell.org/trac/ghc                GHC Developer's Wiki
 [3] http://hackage.haskell.org/trac/ghc/wiki/Building  Building Guide
 [4] http://www.haskell.org/happy/                      Happy
 [5] http://www.haskell.org/alex/                       Alex
 [6] http://www.haskell.org/haddock/                    Haddock
 
 
Contributors
============
 
Please see
 
   http://www.haskell.org/ghc/contributors.html