Skip to content
Snippets Groups Projects
Commit 7699b27c authored by Ben Gamari's avatar Ben Gamari :turtle:
Browse files

doc: Fix option references

(cherry picked from commit f915fb3c74328fb994235bbbd42092a691539197)
parent ea63a598
No related branches found
No related tags found
5 merge requests!38Make --no-tmp-comp-dir the default,!37Adapt to latest xhtml version, various optimizations,!31Support HsToken in DataDecl and ClassDecl,!12Drop orphan instance when defined upstream.,!10Haddock interfaces produced from `.hi` files
......@@ -27,8 +27,8 @@ considered a bug in the new versions. If you ever get failed parsing
message, please report it.
You must also specify an option for the output format. Currently only
the :option:`-h` option for HTML and the :option:`--hoogle` option for outputting
Hoogle data are functional.
the :option:`--html` option for HTML and the :option:`--hoogle` option for
outputting Hoogle data are functional.
The packaging tool
`Cabal <http://www.haskell.org/ghc/docs/latest/html/Cabal/index.html>`__
......@@ -37,8 +37,6 @@ directly.
The following options are available:
.. program:: haddock
.. option:: -B <dir>
Tell GHC that that its lib directory is dir. Can be used to override
......@@ -94,8 +92,7 @@ The following options are available:
Haddock interface files are not the same as Haskell interface files,
I just couldn't think of a better name.
.. option:: -h
--html
.. option:: --html, -h
Generate documentation in HTML format. Several files will be
generated into the current directory (or the specified directory if
......@@ -157,6 +154,11 @@ The following options are available:
is given, then ``haddock.sty`` is not generated, and the command is
instead ``\usepackage{style}``.
.. option:: --hoogle
Generate an index file for the
`Hoogle <http://hackage.haskell.org/package/hoogle>`_ search engine.
.. option:: --hyperlinked-source
Generate hyperlinked source code (as HTML web page). All rendered
......@@ -455,4 +457,3 @@ Since Haddock uses GHC internally, both plain and literate Haskell
sources are accepted without the need for the user to do anything. To
use the C pre-processor, however, the user must pass the the :option:`-cpp`
option to GHC using :option:`--optghc`.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment