Skip to content

Commit

Permalink
Add --hoogle docs, thanks to ndm for the text.
Browse files Browse the repository at this point in the history
  • Loading branch information
Duncan Coutts committed Sep 5, 2006
1 parent d832092 commit 527553f
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions doc/Cabal.xml
Expand Up @@ -1652,6 +1652,22 @@ runhaskell Setup.hs unregister --gen-script</screen>
<title>setup haddock</title>
<para>Build the interface documentation for a library using
&Haddock;.</para>

<variablelist>
<varlistentry>
<term><option>--hoogle</option></term>
<listitem>
<para>Passing the --hoogle flag generates a
<ulink url="http://www.haskell.org/hoogle/">Hoogle</ulink> .hoo
file, at the location dist/doc/html/<package-name>.hoo, which can
be converted by Hoogle into a database for searching. This is
equivalent to running haddock with the --hoogle flag. For more
details about how to use a .hoo file see
<ulink url="http://www.haskell.org/hoogle/">http://www.haskell.org/hoogle/</ulink>.
</para>
</listitem>
</varlistentry>
</variablelist>
</sect2>

<sect2 id="setup-install">
Expand Down

0 comments on commit 527553f

Please sign in to comment.