summaryrefslogtreecommitdiff
path: root/libraries
diff options
context:
space:
mode:
Diffstat (limited to 'libraries')
-rw-r--r--libraries/Makefile3
-rw-r--r--libraries/gen_contents_index1
-rw-r--r--libraries/prologue.txt5
3 files changed, 8 insertions, 1 deletions
diff --git a/libraries/Makefile b/libraries/Makefile
index 01dd45b8ef..20a7678023 100644
--- a/libraries/Makefile
+++ b/libraries/Makefile
@@ -321,6 +321,7 @@ ifeq "$(HADDOCK_DOCS)" "YES"
$(INSTALL_DIR) $(DESTDIR)$(html_installed_root)
$(INSTALL_DATA) index.html doc-index*.html $(DESTDIR)$(html_installed_root)
$(INSTALL_SCRIPT) gen_contents_index $(DESTDIR)$(html_installed_root)
+ $(INSTALL_DATA) prologue.txt $(DESTDIR)$(html_installed_root)
# Hacks:
$(INSTALL_DATA) base/dist/doc/html/*/*.css $(DESTDIR)$(html_installed_root)
$(INSTALL_DATA) base/dist/doc/html/*/*.js $(DESTDIR)$(html_installed_root)
@@ -365,7 +366,7 @@ endif
echo $(WHERE_AM_I)/ifBuildable/ifBuildable >> $(BIN_DIST_LIST)
for FILE in dph/dph-prim-interface/interface/*.h dph/dph/LICENSE; do if [ -f $$FILE ]; then echo $(WHERE_AM_I)/$$FILE >> $(BIN_DIST_LIST); fi; done
ifeq "$(HADDOCK_DOCS)" "YES"
- for FILE in gen_contents_index index.html doc-index*.html; do echo $(WHERE_AM_I)/$$FILE >> $(BIN_DIST_LIST); done
+ for FILE in gen_contents_index prologue index.html doc-index*.html; do echo $(WHERE_AM_I)/$$FILE >> $(BIN_DIST_LIST); done
endif
$(foreach SUBDIR,$(SUBDIRS),binary-dist.library.$(SUBDIR)): \
diff --git a/libraries/gen_contents_index b/libraries/gen_contents_index
index db84b1d2d2..db1856888c 100644
--- a/libraries/gen_contents_index
+++ b/libraries/gen_contents_index
@@ -27,6 +27,7 @@ done
# Now create the combined contents and index pages
$HADDOCK --gen-index --gen-contents -o . \
-t "Haskell Hierarchical Libraries" \
+ -p "prologue.txt" \
$HADDOCK_ARGS
# Unhandled Windows help stuff?:
diff --git a/libraries/prologue.txt b/libraries/prologue.txt
new file mode 100644
index 0000000000..abc83ba6b4
--- /dev/null
+++ b/libraries/prologue.txt
@@ -0,0 +1,5 @@
+
+This index includes documentation for many Haskell modules.
+
+For documentation on the GHC API, see <ghc/index.html>.
+