Skip to content

Passing --hoogle to haddock when building base

In http://www.haskell.org/pipermail/cvs-ghc/2010-November/057376.html Neil asks:

For nearly all packages on hackage, haddock is run over them with --hoogle, which generates documentation (http://hackage.haskell.org/package/stm) and a hoogle database (http://hackage.haskell.org/packages/archive/stm/2.2.0.1/doc/html/stm.txt). However, the base library is special, and hackage can't easily apply haddock to it, so Ross takes the documentation off http://www.haskell.org/ghc/docs/6.12.2/html/libraries/base-4.2.0.1/ and changes the URLs. The result is that the base library does not have a hoogle database on hackage. Would it be possible for the GHC build system to pass --hoogle when running Haddock on the base library, and then include the resulting base.txt everywhere the haddock documentation goes?

I'm revisiting Hoogle development and the base library is the one sticking point before I make a new Hoogle release. In previous versions I made the base library documentation using a series of hacks, but it would be nice to have something more robust and accurate going forward.

Trac metadata
Trac field Value
Version 7.0.1
Type FeatureRequest
TypeOfFailure OtherFailure
Priority normal
Resolution Unresolved
Component Build System
Test case
Differential revisions
BlockedBy
Related
Blocking
CC
Operating system
Architecture
To upload designs, you'll need to enable LFS and have an admin enable hashed storage. More information