Skip to content
Mirror of the Glasgow Haskell Compiler. Patches are best submitted to GHC's GitLab instance (https://gitlab.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). First time contributors are encouraged to get started by just sending a Pull Requ…
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci Update Wiki URLs to point to GitLab Mar 25, 2019
.gitlab linters: Fix check-version-number Apr 13, 2019
bindisttest Update Wiki URLs to point to GitLab Mar 25, 2019
compiler
distrib
docs users-guide: Add libraries section to 8.10.1 release notes Apr 21, 2019
driver Update Wiki URLs to point to GitLab Mar 25, 2019
ghc
hadrian Hadrian: Drop old/unused CI scripts Apr 20, 2019
includes removing x87 register support from native code gen Apr 11, 2019
libffi-tarballs @ 96d0280
libffi Update Wiki URLs to point to GitLab Mar 25, 2019
libraries TH: make `Lift` and `TExp` levity-polymorphic Apr 19, 2019
mk Update Wiki URLs to point to GitLab Mar 25, 2019
nofib @ 7a702cc Bump nofib submodule. Feb 22, 2019
rts Restore Xmm registers properly in StgCRun.c Apr 4, 2019
rules Update Wiki URLs to point to GitLab Mar 25, 2019
testsuite testsuite: fix ifdef lint errors under tests/rts/linker Apr 21, 2019
utils Clean up URLs to point to GitLab Apr 1, 2019
.appveyor.sh Run tests after artifact collection Apr 7, 2018
.ghcid Use ./hadrian/ghci.sh in .ghcid Apr 8, 2019
.gitattributes Force LF line ending for md5sum [skip-ci] Mar 22, 2019
.gitignore
.gitlab-ci.yml gitlab-ci: Do not build profiled libraries on 32-bit Windows Apr 20, 2019
.gitmodules Remove arc scripts Feb 19, 2019
.mailmap Update Wiki URLs to point to GitLab Mar 25, 2019
.travis.yml Attempt to fix travis build Jul 12, 2018
ANNOUNCE
CODEOWNERS
HACKING.md Replace git.haskell.org with gitlab.haskell.org (#16196) Apr 4, 2019
INSTALL.md
LICENSE Reorganisation of the source tree Apr 7, 2006
MAKEHELP.md Update Wiki URLs to point to GitLab Mar 25, 2019
Makefile
README.md [skip ci] Update CI badge in readme Apr 13, 2019
Vagrantfile vagrant: move files around Jul 20, 2014
aclocal.m4 configure: Always use AC_LINK_ELSEIF when testing against assembler Apr 3, 2019
appveyor.yml Full AppVeyor build with tests Mar 29, 2018
boot
build.nix.sh Disable Shake Lint by default. Jan 16, 2019
config.guess Update autoconf scripts Jul 23, 2017
config.sub
configure.ac gitlab-ci: Ensure that version number has three components Apr 12, 2019
ghc.mk Update Wiki URLs to point to GitLab Mar 25, 2019
install-sh Update aux files `config.{guess,sub}` and `install-sh` Nov 7, 2013
llvm-passes
llvm-targets llvm-targets: Add amd64-unknown-freebsd triple Dec 14, 2018
packages Update Trac ticket URLs to point to GitLab Mar 15, 2019
settings.in settings.in: Reformat Apr 8, 2019
validate Update Wiki URLs to point to GitLab Mar 25, 2019

README.md

The Glasgow Haskell Compiler

pipeline 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 issue tracker.

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.

  1. Check out the source code from git

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

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

See the GHC team's working conventions regarding how to contribute a patch to GHC. First time contributors are encouraged to get started by just sending a Pull Request.

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.md.

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 an issue 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!

You can’t perform that action at this time.