Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Mirror of ghc repository. DO NOT SUBMIT PULL REQUESTS HERE. Patches are best submitted to GHC's Trac (http://ghc.haskell.org/trac/ghc) or sent to the mailing list (ghc-devs@haskell.org)

branch: master
Octocat-spinner-32 bindisttest Follow-up to 32f41c7 February 26, 2014
Octocat-spinner-32 compiler Some typos in comments April 24, 2014
Octocat-spinner-32 distrib Fix typo March 23, 2014
Octocat-spinner-32 docs ghc & docs: kill unused flags April 21, 2014
Octocat-spinner-32 driver Update ghc --help references to --make and a.out (fixes #8600) March 22, 2014
Octocat-spinner-32 ghc Separate thousands when printing allocated bytes April 21, 2014
Octocat-spinner-32 includes Add comments to explain the change to EF_ (Trac #8965) April 24, 2014
Octocat-spinner-32 libffi Globally replace "hackage.haskell.org" with "ghc.haskell.org" October 01, 2013
Octocat-spinner-32 libraries Make absolutely sure that 'done' and 'safeIndex' are strict in the index April 24, 2014
Octocat-spinner-32 mk Remove -fno-warn-amp sledgehammers for validate April 20, 2014
Octocat-spinner-32 rts ghc: initial AArch64 patches April 21, 2014
Octocat-spinner-32 rules Handle base et al. specially in foreachLibrary.mk April 22, 2014
Octocat-spinner-32 testsuite Some typos in comments April 24, 2014
Octocat-spinner-32 utils Add System.Exit.die (re #9016) April 21, 2014
Octocat-spinner-32 vagrant Add a simplistic Vagrantfile with bootstrapping March 22, 2014
Octocat-spinner-32 .gitignore Adapt .gitignore (re #8545) April 22, 2014
Octocat-spinner-32 .gitmodules Convert haddock into a proper submodule (re #8545) March 23, 2014
Octocat-spinner-32 .mailmap Update mailmap January 11, 2014
Octocat-spinner-32 ANNOUNCE Globally replace "hackage.haskell.org" with "ghc.haskell.org" October 01, 2013
Octocat-spinner-32 HACKING.md Update `sync-all` and others files w.r.t. merged testsuite (re #8545) January 12, 2014
Octocat-spinner-32 LICENSE Reorganisation of the source tree April 07, 2006
Octocat-spinner-32 MAKEHELP Globally replace "hackage.haskell.org" with "ghc.haskell.org" October 01, 2013
Octocat-spinner-32 Makefile Fix `make help` April 21, 2014
Octocat-spinner-32 README.md Globally replace "hackage.haskell.org" with "ghc.haskell.org" October 01, 2013
Octocat-spinner-32 SUBMAKEHELP Make the "show" target work anywhere in the build tree June 16, 2010
Octocat-spinner-32 Vagrantfile Add a simplistic Vagrantfile with bootstrapping March 22, 2014
Octocat-spinner-32 aclocal.m4 Add the powerpc64le architecture April 21, 2014
Octocat-spinner-32 boot Globally replace "hackage.haskell.org" with "ghc.haskell.org" October 01, 2013
Octocat-spinner-32 config.guess Update aux files `config.{guess,sub}` and `install-sh` November 08, 2013
Octocat-spinner-32 config.sub Update aux files `config.{guess,sub}` and `install-sh` November 08, 2013
Octocat-spinner-32 configure.ac --with-gcc overrides CC_STAGE0 when not cross-compiling (#8498) March 27, 2014
Octocat-spinner-32 ghc.mk Be more aggressive in `make clean` April 22, 2014
Octocat-spinner-32 install-sh Update aux files `config.{guess,sub}` and `install-sh` November 08, 2013
Octocat-spinner-32 packages Update `sync-all` and `packages` wrt to fold-in April 19, 2014
Octocat-spinner-32 settings.in Rework how iOS does linking (#8127) August 28, 2013
Octocat-spinner-32 sync-all Do not use basename() April 19, 2014
Octocat-spinner-32 tarballs Add tarball syncing to darcs-all October 14, 2009
Octocat-spinner-32 validate Update `sync-all` and others files w.r.t. merged testsuite (re #8545) January 12, 2014
README.md

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.

Information for developers of GHC can be found on the GHC Trac.

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 git

    First clone the GHC github read-only repository:

      $ git clone git://github.com/ghc/ghc.git
    

    Then run the sync-all script in that repository to get the other repositories:

      $ cd ghc
      $ ./sync-all get
    

    This checks out the "boot" packages.

    DO NOT submit pull request directly to the github repo. See the GHC developer team's working conventions re contributing patches.

Building & Installing

For full information on building GHC, see the GHC Building Guide. Here follows a summary - if you get into trouble, the Building Guide has all the answers.

Before building GHC you may need to install some other tools and libraries. See, Setting up your system for building GHC.

NB. In particular, you need GHC installed in order to build GHC, because the compiler is itself written in Haskell. You also need Happy, Alex, and Cabal. For instructions on how to port GHC to a new platform, see the GHC Building Guide.

For building library documentation, you'll need Haddock. To build the compiler documentation, you need a good DocBook XML toolchain and dblatex.

Quick start: the following gives you a default build:

$ perl boot
$ ./configure
$ make         # can also say 'make -jX' for X number of jobs
$ make install

(NB: Do you have multiple cores? Be sure to tell that to make! This can save you hours of build time depending on your system configuration, and is almost always a win regardless of how many cores you have. As a simple rule, you should have about N+1 jobs, where N is the amount of cores you have.)

The perl boot step is only necessary if this is a tree checked out from git. 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.

Once you have a build you need to keep it going. You need to keep all repos in sync with the sync-all script. To get the latest changes:

$ ./sync-all pull
$ ./sync-all get

Filing bugs and feature requests

If you've encountered what you believe is a bug in GHC, or you'd like to propose a feature request, please let us know! Submit a ticket in our bug tracker and we'll be sure to look into it. Remember: Filing a bug is the best way to make sure your issue isn't lost over time, so please feel free.

If you're an active user of GHC, you may also be interested in joining the glasgow-haskell-users mailing list, where developers and GHC users discuss various topics and hang out.

Hacking & Developing GHC

Once you've filed a bug, maybe you'd like to fix it yourself? That would be great, and we'd surely love your company! If you're looking to hack on GHC, check out the guidelines in the HACKING.md file in this directory - they'll get you up to speed quickly.

Contributors & Acknowledgements

GHC in its current form wouldn't exist without the hard work of its many contributors. Over time, it has grown to include the efforts and research of many institutions, highly talented people, and groups from around the world. We'd like to thank them all, and invite you to join!

Something went wrong with that request. Please try again.