[Hackage] #674: Findable extra documentation
Hackage
cvs-ghc at haskell.org
Fri Jun 18 19:09:27 EDT 2010
#674: Findable extra documentation
----------------------------+-----------------------------------------------
Reporter: jbapple | Owner:
Type: enhancement | Status: new
Priority: normal | Milestone:
Component: Cabal library | Version: 1.6.0.3
Severity: normal | Keywords:
Difficulty: unknown | Ghcversion:
Platform: |
----------------------------+-----------------------------------------------
Comment(by duncan):
Note for point 2, this relies on us knowing if documentation files are
installed and if so where.
Currently `cabal info pkgname` will report the location of documentation
if the `haddock-html` field points to a directory that exists. This is
only appropriate for html documentation.
One option to support more general documentation would be via cabal
tracking files for packages it installs, however that would not help for
packages installed with ghc or via the system package manager.
Another thing to note here is that the fact that we track whether or not
haddock docs are installed via ghc-pkg. This itself is a bit of an oddity.
It is not information that ghc itself needs and nor is it package meta-
data (like the author or description). It's just auxiliary information
about aspects of the installed package. It's sort of package management
information. It's not clear this special case makes sense. Probably we
should allow more general package information (e.g. location of various
kinds of docs) or we should not track haddock information in the ghc-pkg
registration information at all.
--
Ticket URL: <http://hackage.haskell.org/trac/hackage/ticket/674#comment:2>
Hackage <http://haskell.org/cabal/>
Hackage: Cabal and related projects
More information about the cabal-devel
mailing list