[Hackage] #517: make cabal install command support haddock options
Hackage
trac at galois.com
Tue Mar 3 12:23:40 EST 2009
#517: make cabal install command support haddock options
---------------------------------+------------------------------------------
Reporter: duncan | Owner:
Type: enhancement | Status: new
Priority: normal | Milestone:
Component: cabal-install tool | Version:
Severity: normal | Keywords:
Difficulty: normal | Ghcversion:
Platform: |
---------------------------------+------------------------------------------
Currently the `cabal install` command supports just `--enable-
documentation` which turns on library docs. The `cabal haddock` option has
various other things like enabling docs for executables, specifying css
files, linking to source code etc. Some or perhaps all of these would be
useful when installing packages.
This is not fundamentally difficult. The task is just to work out which
options are useful (or perhaps all) and how to present the user interface
(command line options and config file). Bonus points for a UI that is
usable and orthogonal.
See #206 for some of the previous discussion on this topic. See also #516
about maintaining a central haddock module index.
For reference the current haddock command options are:
{{{
Flags for haddock:
-h --help Show this help text
-v --verbose[=n] Control verbosity (n is 0--3, default verbosity
level is 1)
--builddir=DIR The directory where Cabal puts generated build
files
(default dist)
--hoogle Generate a hoogle database
--html-location=URL Location of HTML documentation for pre-
requisite
packages
--executables Run haddock for Executables targets
--internal Run haddock for internal modules and include
all
symbols
--css=PATH Use PATH as the haddock stylesheet
--hyperlink-source Hyperlink the documentation to the source code
(using HsColour)
--hscolour-css=PATH Use PATH as the HsColour stylesheet
--with-haddock=PATH give the path to haddock
--haddock-options=OPTS give extra options to haddock
--haddock-option=OPT give an extra option to haddock (no need to
quote
options containing spaces)
}}}
--
Ticket URL: <http://hackage.haskell.org/trac/hackage/ticket/517>
Hackage <http://haskell.org/cabal/>
Hackage: Cabal and related projects
More information about the cabal-devel
mailing list