aboutsummaryrefslogtreecommitdiff
path: root/doc/haddock.xml
diff options
context:
space:
mode:
authorross <unknown>2005-05-18 12:41:59 +0000
committerross <unknown>2005-05-18 12:41:59 +0000
commit23281f787a412ebc54c3e3074ed49327f2942e6c (patch)
tree215e681be7eb490186099f805dc06f7db35f8e3c /doc/haddock.xml
parent9e1eb7840dab2790b79892a1c33bc40d0ba1a3c5 (diff)
[haddock @ 2005-05-18 12:41:59 by ross]
fix 3 bugs in --use-package, and document it.
Diffstat (limited to 'doc/haddock.xml')
-rw-r--r--doc/haddock.xml18
1 files changed, 17 insertions, 1 deletions
diff --git a/doc/haddock.xml b/doc/haddock.xml
index f9dbb1ff..c027170c 100644
--- a/doc/haddock.xml
+++ b/doc/haddock.xml
@@ -280,6 +280,22 @@
<varlistentry>
<term>
+ <indexterm><primary><option>--use-package</option></primary></indexterm>
+ <option>--use-package</option>=<replaceable>package</replaceable>
+ </term>
+ <listitem>
+ <para>Like <option>--read-interface</option>, but use
+ <command>ghc-pkg</command> to locate the interface file and
+ HTML documentation for <replaceable>package</replaceable>,
+ to reference when generating the documentation.</para>
+
+ <para>Multiple <option>--use-package</option> options may
+ be given.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>
<indexterm><primary><option>-D</option></primary></indexterm>
<option>-D</option> <replaceable>file</replaceable>
</term>
@@ -619,7 +635,7 @@
all the specified interfaces (interfaces are specified using
<option>-i</option> or <option>--read-interface</option>).
This is used to generate a single index for multiple sets of
- Haddock documentstation.</para>
+ Haddock documentation.</para>
</listitem>
</varlistentry>