Ticket #21 (closed defect: fixed)

Opened 8 years ago

Last modified 6 years ago

clean up haddock for hidden modules

Reported by: anonymous Owned by: ijones
Priority: normal Milestone: Cabal-1.2
Component: Cabal library Version: HEAD
Severity: normal Keywords:
Cc: Difficulty: easy
GHC Version: 6.2.1 Platform: Linux

Description

A patch is attached, but it's out of date, I think. It needs to also work on executables. Also, we need to check that it works on lhs files, and add a test case.

Attachments

cabal.haddock.hidden.modules.patch Download (12.7 KB) - added by ijones 8 years ago.
partial patch

Change History

Changed 8 years ago by ijones

partial patch

Changed 8 years ago by anonymous

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

In fact, this patch handles all of the above cases. Applying and closing this bug :) Thanks, Einar.

Changed 8 years ago by ijones

  • status changed from closed to reopened
  • resolution fixed deleted
  • summary changed from haddock for hidden modules (patch, but needs fixed) to clean up haddock for hidden modules

Ross says:

Haddock complains if a module has two module attribute lines, which it will have if the author has already put one there (or if you run setup haddock twice?). You could check for a module attribute line, but I think it's simpler just to require authors to put the #hide in. Redundant and a little tedious, but modifying source files is clunky.

Changed 8 years ago by anonymous

On 14.11 10:29, Krasimir Angelov wrote:

Some time ago I added support for haddock-izing hidden modules. Cabal just have to supply --hide <module> command line option to Haddock. What is wrong with this and why we need to add #hide pragmas?

The patch in question was created on 14th july, while Haddock 0.7 which added --hide was released in august. That explains why there was no --hide. Using it --hide is better now that Haddock supports it.

Many apologies. I ran across this patch the other day; it might be useful for old versions of haddock; I forgot that a new version had been released w/ the --hide flag. In either case, we should be checking the version of haddock.

Changed 7 years ago by ijones

  • difficulty set to easy

Changed 6 years ago by ross@…

  • status changed from reopened to closed
  • platform set to Linux
  • ghcversion set to 6.2.1
  • resolution set to fixed

fixed by patch "cvs pulls from krasimir and ross" 31 Oct 2005.

Note: See TracTickets for help on using tickets.