Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
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 Perl Logos Other
Branch: master

Backpack docs on renamer and depsolver, also s/package/unit/.

Signed-off-by: Edward Z. Yang <ezyang@cs.stanford.edu>
latest commit 36bbfbd9cf
@ezyang ezyang authored
Failed to load latest commit information.
bindisttest Follow-up to 32f41c7
compiler Fix comment that confused Haddock
distrib configure : LLVM and LD detections improvements (#10234).
docs Backpack docs on renamer and depsolver, also s/package/unit/.
driver Shorten long lines in DynFlags, add details to ghci usage guide.
ghc Delete __GLASGOW_HASKELL__ ifdefs for stage0 < 7.8
includes Make headers C++ compatible (fixes #10700)
libffi-tarballs @ b6658e5 Update libffi-tarballs submodule to libffi 3.1 (re #8701)
libffi libffi: backport noexecstack fix for x86/win32.S
libraries Testsuite: mark tests recently fixed as passing + accept new stderr
mk The parallel package has warnings
nofib @ 85d10a4 update submodule
rts Eliminate zero_static_objects_list()
rules Build system: delete two unused files
testsuite Testsuite: T10245 is passing for WAY=ghci (#10245)
utils Implementation of StrictData language extension
.arcconfig Fix .arcconfig
.arclint Cabal submodule update: hole support and tests.
.gitignore Ignore temporary ./configure files.
.gitmodules Delete old-{time,locale} and haskell{98,2010}
.mailmap Update .mailmap [skip ci]
.travis.yml Travis: do pass `--quiet` to validate
ANNOUNCE Globally replace "hackage.haskell.org" with "ghc.haskell.org"
HACKING.md Make configure error out on missing ghc-tarballs on Windows
INSTALL.md Make configure error out on missing ghc-tarballs on Windows
LICENSE Reorganisation of the source tree
MAKEHELP.md Build system: add `make show!` command (#7810)
Makefile Build system: add `make show!` command (#7810)
README.md Make configure error out on missing ghc-tarballs on Windows
Vagrantfile vagrant: move files around
aclocal.m4 Replace usages of `-w` by `-fno-warn`s
boot Remove all references to sync-all
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 Make configure error out on missing ghc-tarballs on Windows
ghc.mk Build system: fail when encountering an unknown package tag
install-sh Update aux files `config.{guess,sub}` and `install-sh`
packages Remove all references to sync-all
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 Validate: explain THREADS instead of CPUS in --help

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 a good DocBook XML toolchain and dblatex.

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!

Something went wrong with that request. Please try again.