Skip to content

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 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)
Haskell C Makefile Perl6 Bison Perl Other
branch: master

uBackpack: simplified Backpack description.

Signed-off-by: Edward Z. Yang <ezyang@cs.stanford.edu>
latest commit 694c4d543d
@ezyang ezyang authored
Failed to load latest commit information.
bindisttest Follow-up to 32f41c7
compiler Don't treat .hcr and .raw_s as haskellish suffixes
distrib Remove RAWCPP_FLAGS (Task #9094)
docs uBackpack: simplified Backpack description.
driver Shorten long lines in DynFlags, add details to ghci usage guide.
ghc Explicitly check for -C on registerised build (#7563)
includes fix bus errors on SPARC caused by unalignment access to alloc_limit (…
libffi-tarballs @ b6658e5 Update libffi-tarballs submodule to libffi 3.1 (re #8701)
libffi Use the gold linker for linux/ARM and android/ARM targets.
libraries Drop old integer-gmp-0.5 from GHC source tree
mk Drop old integer-gmp-0.5 from GHC source tree
nofib @ 85d10a4 update submodule
rts rts: check arguments to flags that don't have any
rules Drop old integer-gmp-0.5 from GHC source tree
testsuite Testsuite: redirect stderr to /dev/null when running GS on bad.ps
utils Drop old integer-gmp-0.5 from GHC source tree
.arcconfig Fix .arcconfig
.arclint Cabal submodule update: hole support and tests.
.gitignore add -th-file which generates a th.hs file
.gitmodules Delete old-{time,locale} and haskell{98,2010}
.mailmap Add remaining <unknown>s and comments to .mailmap
.travis.yml travis: Get libstdc++ from a more sensible location
ANNOUNCE Globally replace "hackage.haskell.org" with "ghc.haskell.org"
HACKING.md Update `sync-all` and others files w.r.t. merged testsuite (re #8545)
INSTALL.md docs: add INSTALL.md to root dir (#9926)
LICENSE Reorganisation of the source tree
MAKEHELP.md docs: Flatten MAKEHELP/SUBMAKEHELP
Makefile build: fix 'make help'
README.md Explain how to clone GitHub forks. Ticket #8379.
Vagrantfile vagrant: move files around
aclocal.m4 Fix Git-commit-id detection for RELEASE=YES
boot Replace all #!/usr/bin/perl with #!/usr/bin/env perl
config.guess Update config.{guess,sub} to GNU automake 1.14.1
config.sub Update config.{guess,sub} to GNU automake 1.14.1
configure.ac Do version specific detection of LLVM tools (#10170).
ghc.mk Drop old integer-gmp-0.5 from GHC source tree
install-sh Update aux files `config.{guess,sub}` and `install-sh`
packages Declare official GitHub home of libraries/parallel
settings.in LlvmCodeGen cross-compiling fixes (#9895)
sync-all Cleanup and better documentation of sync-all script
tarballs Add tarball syncing to darcs-all
validate `make test` in root directory now runs fulltest

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

    The official mirror for GHC on GitHub is located at https://github.com/ghc/ghc.

      $ git clone git://github.com/ghc/ghc.git
      $ cd ghc
      $ ./sync-all get
    

    If you want to clone your own fork instead, add an argument to sync-all to tell it where it can find the other repositories it needs.

      $ git clone <your preferred github.com GHC fork URL> ghc
      $ cd ghc
      $ ./sync-all -r git://github.com/ghc get
    

    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.