Snippets Groups Projects

Forked from Glasgow Haskell Compiler / GHC

13930 commits behind the upstream repository.

5 years ago

Update `$(TOP)/*.md` documents · 0b01a354

Takenobu Tani authored 5 years ago and

Marge Bot committed 5 years ago

I updated the top documents to the latest status:

  - HACKING.md:
    - Modify Phabricator to GitLab infomation
    - Remove old Trac information
    - Add link to GitLab activity

  - MAKEHELP.md:
    - Add link to hadrian wiki
    - Fix markdown format

  - INSTALL.md:
    - Modify boot command to remove python3
    - Fix markdown format

  - README.md:
    - Modify tarball file suffix
    - Fix markdown format

I checked the page display on the GitHub and GitLab web.

[skip ci]

0b01a354

Update `$(TOP)/*.md` documents

Takenobu Tani authored 5 years ago and

Marge Bot committed 5 years ago

I updated the top documents to the latest status:

  - HACKING.md:
    - Modify Phabricator to GitLab infomation
    - Remove old Trac information
    - Add link to GitLab activity

  - MAKEHELP.md:
    - Add link to hadrian wiki
    - Fix markdown format

  - INSTALL.md:
    - Modify boot command to remove python3
    - Fix markdown format

  - README.md:
    - Modify tarball file suffix
    - Fix markdown format

I checked the page display on the GitHub and GitLab web.

[skip ci]

Code owners

Assign users and groups as approvers for specific file changes. Learn more.

INSTALL.md 1.70 KiB

Building & Installing

For full information on building GHC, see the GHC Building Guide [1]. 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" [2].

N.B. in particular you need GHC installed in order to build GHC, because the compiler is itself written in Haskell. For instructions on how to port GHC to a new platform, see the Building Guide [1].

For building library documentation, you'll need Haddock [3]. 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
$ 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

You can use Make's -jN option to parallelize the build. It's generally best to set N somewhere around the core count of the build machine.

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.

References