[project @ 2002-07-02 13:13:36 by simonmar]

Add descriptions to the top level of each package documentation

diff --git a/Makefile b/Makefile
index dfd2bfb..8cc4bf3 100644 (file)
--- a/Makefile
+++ b/Makefile
@@ -1,5 +1,5 @@
 # -----------------------------------------------------------------------------
-# $Id: Makefile,v 1.35 2002/06/24 14:40:02 simonmar Exp $
+# $Id: Makefile,v 1.36 2002/07/02 13:13:36 simonmar Exp $
 
 TOP=..
 include $(TOP)/mk/boilerplate.mk
@@ -105,7 +105,8 @@ EXCLUDED_HADDOCK_SRCS = \
        Data/Generics.hs \
        GHC/PArr.hs
 
-SRC_HADDOCK_OPTS += -t "Haskell Core Libraries (base package)" --no-implicit-prelude
+SRC_HADDOCK_OPTS += -t "Haskell Core Libraries (base package)" \
+       --no-implicit-prelude -p prologue.txt
 
 # -----------------------------------------------------------------------------
 

diff --git a/prologue.txt b/prologue.txt
new file mode 100644 (file)
index 0000000..601b61d
--- /dev/null
+++ b/prologue.txt
@@ -0,0 +1,7 @@
+The @base@ package contains the "Prelude" and its support libraries,
+and a large collection of useful libraries ranging from data
+structures to parsing combinators and debugging utilities.
+
+The @base@ package is enabled by default; to import any of the modules
+listed here just import it by name.  Remember to give the /fully
+qualified/ name when importing a module from the hierarchy.