Difference between revisions of "GHC/Documentation"

From HaskellWiki
Jump to: navigation, search
(Added link to Using the FFI page)
Line 1: Line 1:
== GHC Documentation ==
The documentation below relates to ''using'' GHC. For documentation about the internals of GHC, head over to the [http://hackage.haskell.org/trac/ghc GHC Developer Wiki].
These documents relate to the ''latest released'' version of GHC.
For ''earlier released'' versions click the relevant version on the
[http://www.haskell.org/ghc/download.html downloads page].
For the the ''current HEAD snapshot'' look at
[http://www.haskell.org/ghc/download.html#snapshots the bottom of the downloads page].
; [http://www.haskell.org/ghc/docs/latest/html/users_guide/index.html The User's Guide]: The User's Guide has all you need to know about using GHC: command line options, language extensions, GHCi, etc.
: Download: | [http://www.haskell.org/ghc/docs/latest/users_guide.html.tar.gz HTML.tar.gz] | [http://www.haskell.org/ghc/docs/latest/users_guide.pdf PDF] | [http://www.haskell.org/ghc/docs/latest/users_guide.ps.gz A4 Postscript (gzipped)] |
; [http://www.haskell.org/ghc/docs/latest/html/libraries/index.html Hierarchical Libraries]: Documentation for the hierarchical libraries that come with GHC.
: Download: | [http://www.haskell.org/ghc/docs/latest/libraries.html.tar.gz HTML.tar.gz] |
; [http://www.haskell.org/ghc/docs/latest/html/Cabal/index.html Cabal]: An infrastructure for building and distributing Haskell software.
: Download: | [http://www.haskell.org/ghc/docs/latest/Cabal.html.tar.gz HTML.tar.gz] | [http://www.haskell.org/ghc/docs/latest/Cabal.pdf PDF] | [http://www.haskell.org/ghc/docs/latest/Cabal.ps.gz A4 Postscript (gzipped)] |
; [http://www.haskell.org/ghc/docs/latest/html/hslibs/index.html (Old) Haskell Libraries]: Previous versions of GHC (before version 5.04) came with a suite of libraries known as <tt>hslibs</tt>, aka the Hugs-GHC libraries. As we are in the process of moving towards using hierarchical libraries for everything, many of these libraries have moved over to the new packages in the hierarchical libraries above. We still provide the old <tt>hslibs</tt> libraries for backwards compatibility and also for those libraries which have yet to move into the hierarchy. For libraries which have moved, the documentation contains a pointer to the location in the new libraries. <em>NOTE: These libraries are scheduled for removal in GHC 6.6.</em> See also: [http://www.haskell.org/ghc/docs/edison/index.html Edison] (part of hslibs/data).
: Download: | [http://www.haskell.org/ghc/docs/latest/hslibs.html.tar.gz HTML.tar.gz] | [http://www.haskell.org/ghc/docs/latest/hslibs.pdf PDF] | [http://www.haskell.org/ghc/docs/latest/hslibs.ps.gz A4 Postscript (gzipped)] |
; [http://www.haskell.org/ghc/docs/latest/html/building/index.html GHC Building Guide]: Information on how to build GHC from sources, access the CVS repository, and port GHC to a new platform.
: Download: | [http://www.haskell.org/ghc/docs/latest/building.html.tar.gz HTML.tar.gz] | [http://www.haskell.org/ghc/docs/latest/building.pdf PDF] | [http://www.haskell.org/ghc/docs/latest/building.ps.gz A4 Postscript (gzipped)] |
== Collaborative documentation ==
GHC is a big system. We try to document the core functionality (above), but
you can help by writing documentation yourself. This section collects
documentation written in a collaborative way, by users and developers together.
Please help by adding new sections, and by clarifying and improving existing ones.
* The [[Performance|Haskell Performance Resource]], for advice on improving the performance of your code
* [[GHC/As a library|Using GHC as a library]]
* [[GHC/Concurrency|Concurrent programming in GHC]]
* [[Template_Haskell|Template Haskell]] is a (GHC) extension to Haskell that adds compile-time metaprogramming facilities.
* [http://www.cse.unsw.edu.au/~dons/hs-plugins Dynamically loaded Haskell modules]. <tt>hs-plugins</tt> is a Don Stewart's library for loading code written in Haskell into an application at runtime, in the form of plugins. It also provides a mechanism for (re-)compiling Haskell source at runtime. Thirdly, a combination of runtime compilation and dynamic loading provides a set of eval functions: a form of runtime metaprogramming. Values exported by Haskell plugins are transparently available to Haskell host applications, and bindings exist to use Haskell plugins from at least C and Objective C programs.
* [[GHC/Using the FFI|Using the Foreign Function Interface]]
== Development of GHC ==
See the [http://hackage.haskell.org/trac/ghc GHC Developer Wiki]. The latest snapshot of the documentation for the next version can be found [http://haskell.org/ghc/dist/current/docs/ here].

Latest revision as of 21:34, 21 April 2006

Redirect to: