patch applied (ghc): Fix bug #1725 (Haddock links between
packages)
Simon Peyton-Jones
simonpj at microsoft.com
Mon Sep 24 03:17:40 EDT 2007
| Sun Sep 23 05:06:36 PDT 2007 sven.panne at aedion.de
| * Fix bug #1725 (Haddock links between packages)
| Resolving this bug is a bit tricky, it boils down to the question:
| Should the
| Haddock links between packages include the package version or not?
|
| Pro: We can differentiate between various versions of the same
| package,
| installed all at once. (How often does this really happen in
| practice?)
|
| Cons: When package A refers to a package B, and B is later upgraded,
| links
| in A's documentation will break. Furthermore, if an *additional*
| version of
| B is installed, which version should A refer to?
Arguably, A's documentation should not break. In principle you can have many versions of A and B installed, and they should each have distinct documentation.
If you uninstall B then A breaks anyway, since A depends on (that version of) B, so you'd better uninstall A.
I suppose A could depend on a *range* of versions of B. In that case, A would not break if you upgrade, so really A's documentation should link to any B in that range. Darn I can see that's hard if you don't want to leave HTML.
Simon
More information about the Cvs-ghc
mailing list