Skip to content

Conversation

mpickering
Copy link
Collaborator

This fixes #11217

No test, as it is difficult to test since you need to:

  1. Ensure there is a package registration with ${pkgroot}
  2. Check the existence of a certain link in the generated HTML.

Manual QA: Inspect the output of running cabal haddock on a package and notice the links to base documentation work.

Please read Github PR Conventions and then fill in one of these two templates.


Template Α: This PR modifies behaviour or interface

Include the following checklist in your PR:


Template B: This PR does not modify behaviour or interface

E.g. the PR only touches documentation or tests, does refactorings, etc.

Include the following checklist in your PR:

  • Patches conform to the coding conventions.
  • Is this a PR that fixes CI? If so, it will need to be backported to older cabal release branches (ask maintainers for directions).

@mpickering mpickering changed the title Expand ${pkgroot} variable when reading haddock-html field from ghc-pkg. Expand ${pkgroot} variable when reading haddock-html field from ghc-pkg Sep 16, 2025
This fixes #11217

No test, as it is difficult to test since you need to:

1. Ensure there is a package registration with ${pkgroot}
2. Check the existence of a certain link in the generated HTML.
@mpickering mpickering force-pushed the wip/fix-pkgroot-haddock-html branch from 703b36f to 31e3f33 Compare September 16, 2025 15:58
packages: Cabal
prs: #11218

Links to installed documentation (i.e. for base) from generated haddock should
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would explain why here (that is, mention ${pkgroot}).

I'm not sure if this might count as significant. Artem/others?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

${pkgroot} is not expanded when present in html-haddock field
3 participants