Ticket #4521 (closed feature request: fixed)

Opened 2 years ago

Last modified 2 years ago

Passing --hoogle to haddock when building base

Reported by: igloo Owned by:
Priority: normal Milestone: 7.2.1
Component: Build System Version: 7.0.1
Keywords: Cc: ndmitchell@…
Operating System: Unknown/Multiple Architecture: Unknown/Multiple
Type of failure: None/Unknown Difficulty:
Test Case: Blocked By:
Blocking: Related Tickets:

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

Changed 2 years ago by NeilMitchell

  • cc ndmitchell@… added

This would be fantastically useful for Hoogle.

Changed 2 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.

Changed 2 years ago by igloo

  • status changed from new to merge
  • milestone changed from 7.0.2 to 7.0.3

Fixed in HEAD:

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

Changed 2 years ago by igloo

  • status changed from merge to closed
  • resolution set to fixed

Merged

Note: See TracTickets for help on using tickets.