Mirror of the Glasgow Haskell Compiler. Patches are best submitted to GHC's Phabricator (https://phabricator.haskell.org/), bugs and feature-requests are best filed to GHC's Trac (https://ghc.haskell.org/trac/ghc), or sent to the mailing list (ghc-devs@haskell.org). We will accept easily-reviewed documentation changes as GitHub Pull Requests.
Haskell C Makefile Terra Logos Python Other
Permalink
Failed to load latest commit information.
.arc-linters Testsuite: don't use --interactive in Makefiles May 27, 2016
bindisttest Rework CC/CC_STAGE0 handling in `configure.ac` Apr 16, 2016
compiler Comments and manual only: spelling Sep 28, 2016
distrib distrib: Fix libdw bindist check Sep 5, 2016
docs Comments and manual only: spelling Sep 28, 2016
driver Fix: #12084 deprecate old profiling flags May 24, 2016
ghc Add -flocal-ghci-history flag (#9089). Aug 31, 2016
includes Expose hs_exit_(rtsFalse) as hs_exit_nowait() Sep 23, 2016
inplace Testsuite: suggest quoting $(TEST_HC) Oct 30, 2015
iserv iserv: Show usage message on argument parse failure Aug 31, 2016
libffi-tarballs @ ec37a68 Update libffi-tarballs submodule to libffi 3.1 (re #10238) Dec 8, 2015
libffi Build system: temp solution for parallelisation bug (#11960) May 22, 2016
libraries TH: Use atomicModifyIORef' for fresh names Sep 27, 2016
mk Kill vestiages of DEFAULT_TMPDIR Sep 1, 2016
nofib @ bed591d Kill vestiages of DEFAULT_TMPDIR Sep 1, 2016
rts Expose hs_exit_(rtsFalse) as hs_exit_nowait() Sep 23, 2016
rules Remove directories from include paths Sep 16, 2016
testsuite Comments and manual only: spelling Sep 28, 2016
utils Bump Haddock submodule to fix rendering of class methods Sep 20, 2016
.arcconfig Reenable external-json linters Mar 29, 2016
.arclint Testsuite: don't use --interactive in Makefiles May 27, 2016
.gitignore Testsuite: validate the tests/stage1 directory with the stage1 compiler Jun 18, 2016
.gitmodules Ignore untracked in nofib Feb 11, 2016
.mailmap Update .mailmap [skip ci] May 18, 2016
.travis.yml Travis: llvm's apt repository is offline Jun 2, 2016
ANNOUNCE ANNOUNCE: Mention powerpc code generator Jan 15, 2016
HACKING.md Make configure error out on missing ghc-tarballs on Windows Jul 30, 2015
INSTALL.md INSTALL.md: Mention -j and other wibbles Jan 14, 2016
LICENSE Reorganisation of the source tree Apr 7, 2006
MAKEHELP.md Build system: implement `make install-strip` (#1851) Sep 4, 2015
Makefile configure.ac: Remove checks for bug 9439 Aug 6, 2016
README.md Fix readme link to FixingBugs wiki page Mar 11, 2016
Vagrantfile vagrant: move files around Jul 20, 2014
aclocal.m4 pass -z wxneeded or -Wl,-zwxneeded for linking on OpenBSD Aug 22, 2016
boot Unset GREP_OPTIONS in build system Feb 9, 2016
config.guess Update config.{guess,sub} to GNU automake 1.14.1 Sep 16, 2014
config.sub Update config.{guess,sub} to GNU automake 1.14.1 Sep 16, 2014
configure.ac configure.ac: fix --host= handling Sep 2, 2016
ghc.mk Fix doc build inconsistency Aug 26, 2016
install-sh Update aux files `config.{guess,sub}` and `install-sh` Nov 7, 2013
packages Make random an "extra" package May 11, 2016
settings.in LlvmCodeGen cross-compiling fixes (#9895) Dec 28, 2014
validate Validate: use `rm -f` instead of `rm` Jun 18, 2016

README.md

The Glasgow Haskell Compiler

Build Status

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

    $ git clone --recursive git://git.haskell.org/ghc.git
    

    Note: cloning GHC from Github requires a special setup. See Getting a GHC repository from Github.

    DO NOT submit pull request directly to the github repo. See the GHC team's working conventions re how to contribute a patch to GHC.

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 Sphinx and Xelatex (only for PDF output).

Quick start: the following gives you a default build:

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

On Windows, you need an extra repository containing some build tools. These can be downloaded for you by configure. This only needs to be done once by running:

$ ./configure --enable-tarballs-autodownload

(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 ./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.

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!