Fix haddock interface and HTML paths for sub-libraries#11476
Merged
Conversation
60e17d6 to
4ae957b
Compare
ulysses4ever
approved these changes
Feb 5, 2026
Collaborator
ulysses4ever
left a comment
There was a problem hiding this comment.
Looks great to me, thanks!
We have long had an issue with missing links to reexports on the Hackage page: https://hackage.haskell.org/package/Cabal (e.g. Distribution.Backpack, which is reexported from Cabal-syntax, isn't linked). I wonder if a similar patch would be required to fix that (a patch for hackage-server, presumably, as it generates the package pages on its own AFAIR).
Sub-libraries now use a subdirectory named after the sub-library for their haddock interface files and HTML documentation paths. Previously, both main and sub-libraries shared the same paths, which caused haddock to emit "could not find link destinations" warnings when using `--haddock-all` with internal sub-libraries. Adds a test case verifying `cabal haddock --haddock-all` works correctly with an internal sub-library.
Contributor
Author
|
Yes! This seems to have been broken since 9.6, I'm not sure what changed. |
geekosaur
approved these changes
Feb 5, 2026
Previously the test passed before the change was applied.
mpickering
requested changes
Feb 10, 2026
Collaborator
mpickering
left a comment
There was a problem hiding this comment.
Thanks for taking the time to look into this issue @Tritlo.
I've left two comments, fixes for the comments are on this branch - https://github.com/haskell/cabal/tree/wip/haddock-internal-library
Contributor
Author
|
Merged! |
Member
|
CI seems stuck. Let me try to restart it... |
Member
|
Success! Restarting has been enough to make it green. Thank you for the PR! |
Contributor
Merge Queue StatusRule:
This pull request spent 11 minutes 31 seconds in the queue, with no time running CI. Required conditions to merge
|
geekosaur
pushed a commit
to geekosaur/cabal
that referenced
this pull request
Mar 4, 2026
* Fix haddock interface and HTML paths for sub-libraries Sub-libraries now use a subdirectory named after the sub-library for their haddock interface files and HTML documentation paths. Previously, both main and sub-libraries shared the same paths, which caused haddock to emit "could not find link destinations" warnings when using `--haddock-all` with internal sub-libraries. Adds a test case verifying `cabal haddock --haddock-all` works correctly with an internal sub-library. * Assert that the test output doesn't contain an error Previously the test passed before the change was applied. * Use library function for computing the haddock directory --------- Co-authored-by: Matthew Pickering <matthewtpickering@gmail.com>
zlonast
pushed a commit
to zlonast/cabal
that referenced
this pull request
Mar 17, 2026
* Fix haddock interface and HTML paths for sub-libraries Sub-libraries now use a subdirectory named after the sub-library for their haddock interface files and HTML documentation paths. Previously, both main and sub-libraries shared the same paths, which caused haddock to emit "could not find link destinations" warnings when using `--haddock-all` with internal sub-libraries. Adds a test case verifying `cabal haddock --haddock-all` works correctly with an internal sub-library. * Assert that the test output doesn't contain an error Previously the test passed before the change was applied. * Use library function for computing the haddock directory --------- Co-authored-by: Matthew Pickering <matthewtpickering@gmail.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #11475
Summary
haddockInterfacesandhaddockHTMLspaths ingeneralInstalledPackageInfoto include the sub-library name subdirectory for internal librariescabal haddock --haddock-allcan't find the.haddockinterface file for internal sub-libraries, causing "could not find link destinations" warnings and missing documentationChecklist
significance: significantin the changelog file.QA Notes
cabal haddock --haddock-all