summaryrefslogtreecommitdiff
path: root/libraries
diff options
context:
space:
mode:
authorsimonmar <unknown>2002-07-02 13:13:37 +0000
committersimonmar <unknown>2002-07-02 13:13:37 +0000
commit3f4ad5db93ad5802edccf7a47a2e4cf7ca49afff (patch)
tree2e475f869a6d46d448d679d2aba300e3333fcf2d /libraries
parenteb74c19485a521b810cd2f0e49b6ea0e9d869e37 (diff)
downloadhaskell-3f4ad5db93ad5802edccf7a47a2e4cf7ca49afff.tar.gz
[project @ 2002-07-02 13:13:36 by simonmar]
Add descriptions to the top level of each package documentation
Diffstat (limited to 'libraries')
-rw-r--r--libraries/base/Makefile5
-rw-r--r--libraries/base/prologue.txt7
2 files changed, 10 insertions, 2 deletions
diff --git a/libraries/base/Makefile b/libraries/base/Makefile
index dfd2bfbc98..8cc4bf39f5 100644
--- a/libraries/base/Makefile
+++ b/libraries/base/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/libraries/base/prologue.txt b/libraries/base/prologue.txt
new file mode 100644
index 0000000000..601b61d1b3
--- /dev/null
+++ b/libraries/base/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.