From: simonmar Date: Mon, 1 Jul 2002 14:27:26 +0000 (+0000) Subject: [project @ 2002-07-01 14:27:26 by simonmar] X-Git-Tag: Approx_11550_changesets_converted~1920 X-Git-Url: http://git.megacz.com/?a=commitdiff_plain;h=4845f07290465c9059ff7b5eb7a4ef14eefff838;p=ghc-hetmet.git [project @ 2002-07-01 14:27:26 by simonmar] Add a top-level HTML page pulling together all the GHC documentation. --- diff --git a/ghc/docs/Makefile b/ghc/docs/Makefile index cf8be1f..41b99c3 100644 --- a/ghc/docs/Makefile +++ b/ghc/docs/Makefile @@ -8,4 +8,7 @@ export WAYS= SUBDIRS = users_guide +install-docs :: index.html + $(INSTALL_DATA) $(INSTALL_OPTS) index.html $(datadir)/html + include $(TOP)/mk/target.mk diff --git a/ghc/docs/index.html b/ghc/docs/index.html new file mode 100644 index 0000000..f4c58fb --- /dev/null +++ b/ghc/docs/index.html @@ -0,0 +1,60 @@ + + + +GHC Documentation + + +

GHC Documentation

+ +

Welcome to GHC! + +

This is the top of the GHC documentation tree, where you will find +links to all the supplied documentation about GHC and its +libraries.

+ +

The User's Guide +
The User's Guide has all you need to know about using GHC: + command line options, language extensions, GHCi, etc. +

Hierarchical Libraries + +
GHC comes with a large number of libraries, arranged + hierarchically. The libraries are divided into packages - + to use a package of libraries from GHC or GHCi just add the flag + -package <name> to the command line, where + <name> is the name of the package (see the + section on packages in the User's Guide for more information). The + base and haskell98 packages are always available, + so you don't need to use the -package flag to get these. + +
+
- base package
- haskell98 package
- network package
- hssource package
+

(Old) Haskell Libraries + +
Previous versions of GHC (before version 5.04) came with a suite + of libraries known as hslibs, 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 hslibs 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. +

+ + +