[commit: haddock] alexbiehl-patch-1, ghc-head, ghc-head1, haddock-quick, headdock-library-1.4.5, ie_avails, master, pr-filter-maps, pr/cabal-desc, travis, v2.18, wip-located-module-as, wip/D2418, wip/T12105, wip/T12105-2, wip/T12942, wip/T13163, wip/T3384, wip/embelleshed-rdr, wip/new-tree-one-param, wip/rae, wip/remove-frames, wip/remove-frames1, wip/revert-ttg-2017-11-20, wip/ttg-2017-10-13, wip/ttg-2017-10-31, wip/ttg-2017-11-06, wip/ttg2-2017-11-10, wip/ttg3-2017-11-12, wip/ttg4-constraints-2017-11-13: doc: Fix option references (ccb14e9)

git at git.haskell.org git at git.haskell.org
Mon Nov 20 21:01:01 UTC 2017


Repository : ssh://git@git.haskell.org/haddock

On branches: alexbiehl-patch-1,ghc-head,ghc-head1,haddock-quick,headdock-library-1.4.5,ie_avails,master,pr-filter-maps,pr/cabal-desc,travis,v2.18,wip-located-module-as,wip/D2418,wip/T12105,wip/T12105-2,wip/T12942,wip/T13163,wip/T3384,wip/embelleshed-rdr,wip/new-tree-one-param,wip/rae,wip/remove-frames,wip/remove-frames1,wip/revert-ttg-2017-11-20,wip/ttg-2017-10-13,wip/ttg-2017-10-31,wip/ttg-2017-11-06,wip/ttg2-2017-11-10,wip/ttg3-2017-11-12,wip/ttg4-constraints-2017-11-13
Link       : http://git.haskell.org/haddock.git/commitdiff/ccb14e9cae57a356d86a7ac1ac800fcf0f3ea6e1

>---------------------------------------------------------------

commit ccb14e9cae57a356d86a7ac1ac800fcf0f3ea6e1
Author: Ben Gamari <ben at smart-cactus.org>
Date:   Mon Mar 28 17:02:14 2016 +0200

    doc: Fix option references
    
    (cherry picked from commit f915fb3c74328fb994235bbbd42092a691539197)


>---------------------------------------------------------------

ccb14e9cae57a356d86a7ac1ac800fcf0f3ea6e1
 doc/invoking.rst | 15 ++++++++-------
 1 file changed, 8 insertions(+), 7 deletions(-)

diff --git a/doc/invoking.rst b/doc/invoking.rst
index c69c903..13cb9f1 100644
--- a/doc/invoking.rst
+++ b/doc/invoking.rst
@@ -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`.
-



More information about the ghc-commits mailing list