Ticket #534 (new enhancement)

Opened 11 months ago

Last modified 10 months ago

cabal haddock should --hyperlink-source by default

Reported by: adamvo Owned by:
Priority: normal Milestone: _|_
Component: Cabal library Version: 1.6.0.1
Severity: normal Keywords:
Cc: Difficulty: very easy (<1 hour)
GHC Version: Platform:

Description

The results from cabal haddock --hyperlink-source are very nice, but quite frequently the haddocks are not built with this (all recent hackage libs iirc).

Would there be a problem with generating the source links by default if and only if a HsColour? can be found?

Or should this issue instead be resolved at the haddock level?

Change History

  Changed 11 months ago by duncan

  • milestone set to _|_

The hackage libs do all have the sources. You're thinking of the docs that were built with ghc 6.10.1. That mistake has been corrected.

My personal opinion is that nothing need changing. I'll leave the ticket open to give others a chance to comment.

follow-up: ↓ 3   Changed 11 months ago by coeus

I like the hyperlinked sources, too. For this, I abuse cabal-install in bash scripts to download packages and their dependencies from hackage, because the following is still not possible:

cabal install --hyperlink-source packagename

I always have to unpack, configure, build, and "haddock --hyperlink-source" each package, just to have the sources hyperlinked. I don't know any other solution to this.

Imho, it would be nice to have an option for that default behaviour in the config file. "documentation: True" is just not enough.

in reply to: ↑ 2   Changed 10 months ago by duncan

Replying to coeus:

Imho, it would be nice to have an option for that default behaviour in the config file. "documentation: True" is just not enough.

Indeed. The implementation is unlikely to be difficult. All we are waiting for is for someone to come up with a coherent design. The existing ticket is: #517.

Making the default be --hyperlink-source is just a cop-out for not properly addressing the above ticket.

Note: See TracTickets for help on using tickets.