Opened 9 years ago

Closed 9 years ago

Last modified 15 months ago

#4521 closed feature request (fixed)

Passing --hoogle to haddock when building base

Reported by: igloo Owned by:
Priority: normal Milestone: 7.2.1
Component: Build System (make) Version: 7.0.1
Keywords: Cc: ndmitchell@…
Operating System: Unknown/Multiple Architecture: Unknown/Multiple
Type of failure: None/Unknown Test Case:
Blocked By: Blocking:
Related Tickets: Differential Rev(s):
Wiki Page:

Description

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.

Change History (5)

comment:1 Changed 9 years ago by NeilMitchell

Cc: ndmitchell@… added

This would be fantastically useful for Hoogle.

comment:2 Changed 9 years ago by NeilMitchell

I'm tracking this in my bug tracker: http://code.google.com/p/ndmitchell/issues/detail?id=386

It's also blocking 5 other Hoogle bugs, to do with out of date or incorrect search results from the base library.

comment:3 Changed 9 years ago by igloo

Milestone: 7.0.27.0.3
Status: newmerge

Fixed in HEAD:

Sun Dec 19 12:52:43 GMT 2010  Ian Lynagh <igloo@earth.li>
  * Pass --hoogle to haddock; fixes trac #4521

comment:4 Changed 9 years ago by igloo

Resolution: fixed
Status: mergeclosed

Merged

comment:5 Changed 15 months ago by bgamari

Component: Build SystemBuild System (make)

The new Hadrian build system has been merged. Relabeling the tickets concerning the legacy make build system to prevent confusion.

Note: See TracTickets for help on using tickets.