Personal tools

GHC/Documentation

From HaskellWiki

< GHC(Difference between revisions)
Jump to: navigation, search
 
(14 intermediate revisions by 6 users not shown)
Line 1: Line 1:
== GHC Documentation ==
+
#REDIRECT [[GHC]]
 
+
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 version of GHC.
+
For earlier versions click the relevant version on the
+
[http://www.haskell.org/ghc/download.html 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/users_guide/faq.html FAQ]:  Frequently asked questions, please edit!
+
 
+
; [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 FAQ above is also freely editable, so please improve that too.
+
 
+
* Notes about [[GHC:as a library|using GHC as a library]]
+
* Notes about [[GHC:concurrency|concurrent programming in GHC]]
+
* Notes about [http://www.haskell.org/hawiki/TemplateHaskell Template Haskell]. (NB: this is still in Hawiki.  Can someone move it to HaskellWiki please?)
+

Latest revision as of 21:34, 21 April 2006

  1. REDIRECT GHC