Building and Porting GHC

This Guide is primarily aimed at those who want to build and/or hack on GHC. It describes how to get started with building GHC on your machine, and how to tweak the settings to get the kind of build you want. It also describes the inner workings of the build system, so you can extend it, modify it, and use it to build your code.

Contents

Building GHC

• Setting up your system for building GHC
• Getting the sources
• Just building and installing GHC
• Platforms that GHC currently supports
• The GHC Builder, which coordinates distributed nightly builds

Getting started for developers

• Getting started with the build system
• How do I re-build after updating or changing GHC?
• Working Conventions (Git workflows, bug tracker, coding style etc.)

More detailed information about using the build system

• Using the build system
• Standard targets
• Making GHC's source code searchable with Hoogle
• Building the documentation
• Installing GHC from a build
• Unregisterised builds

Platform-specific building notes (see also Setting up your system for building GHC)

• Building under MacOS X
• Building under Solaris
• Building under FreeBSD

How to test and benchmark changes to GHC

• Validating changes
• Running the GHC test framework
• The NoFib benchmark suite
• Testing GHC against all of Hackage
• Debugging and performance-tuning for GHC
• Installing extra packages for your in-place GHC

More detailed information about how the build system works

• Overview of files and directories
• Architecture of the build system
• Modifying the build system
• The libraries on which GHC depends

Porting GHC and building cross compilers

• Cross-compilation

Troubleshooting

• FAQ: Solving common problems with building GHC

Contributed documentation

Please feel free to add pages here. In due course, information can be incorporated into the main documentation above.

• SonyPS3 : Hints for building on the Sony PS3