aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLuke Plant <L.Plant.98@cantab.net>2008-08-11 15:20:59 +0000
committerLuke Plant <L.Plant.98@cantab.net>2008-08-11 15:20:59 +0000
commitd3f63f3ffb83a4684836a1aa9c0168ccb93d73e9 (patch)
tree0daeb959db78536052be54ad7ecdf81d5a4ad981
parent47cc837766da0b3a573a5c41ecf77416fe69882b (diff)
invoking haddock clarification and help
-rw-r--r--doc/haddock.xml9
1 files changed, 9 insertions, 0 deletions
diff --git a/doc/haddock.xml b/doc/haddock.xml
index cb02a1bd..f9a553bc 100644
--- a/doc/haddock.xml
+++ b/doc/haddock.xml
@@ -220,6 +220,15 @@
<para>The modules should <emphasis>not</emphasis> be mutually
recursive, as Haddock don't like swimming in circles.</para>
+ <para>You must also specify an option for the output format.
+ Currently only the <option>-h</option> for HTML is
+ functional.</para>
+
+ <para>The packaging
+ tool <ulink url="http://www.haskell.org/ghc/docs/latest/html/Cabal/index.html">Cabal</ulink>
+ has Haddock support, and is often used instead of invoking Haddock
+ directly.</para>
+
<para>The following options are available:</para>
<variablelist>