Skip to content

Expand ${pkgroot} variable when reading haddock-html field from ghc-pkg - #11218

Merged
mergify[bot] merged 1 commit into
masterfrom
wip/fix-pkgroot-haddock-html
Jan 25, 2026
Merged

mergify[bot] merged 1 commit into
masterfrom
wip/fix-pkgroot-haddock-html

Conversation

@mpickering

Copy link
Copy Markdown
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
@mpickering
mpickering force-pushed the wip/fix-pkgroot-haddock-html branch from 703b36f to 31e3f33 Compare September 16, 2025 15:58
Comment thread changelog.d/pr-11218.md Outdated
@LightAndLight

Copy link
Copy Markdown

What's required to get this merged? While simple, this is an important fix for cabal haddock.

@geekosaur

Copy link
Copy Markdown
Collaborator

We're waiting on @mpickering (ping!) to respond to a change request.

@mpickering
mpickering force-pushed the wip/fix-pkgroot-haddock-html branch 2 times, most recently from 454d51a to 6da926e Compare January 20, 2026 14:37
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 6da926e to 423ce6c Compare January 20, 2026 14:43
@mpickering

Copy link
Copy Markdown
Collaborator Author

@geekosaur I've fixed the changelog entry now, would you be able to approve?

@geekosaur

Copy link
Copy Markdown
Collaborator

@LightAndLight, would you like to set the merge me label?

@LightAndLight

Copy link
Copy Markdown

I can't change the label (not a maintainer)

@mpickering mpickering added the merge me Tell Mergify Bot to merge label Jan 23, 2026
@mpickering

Copy link
Copy Markdown
Collaborator Author

I've added the label.

@mergify mergify Bot added ready and waiting Mergify is waiting out the cooldown period merge delay passed Applied (usually by Mergify) when PR approved and received no updates for 2 days queued labels Jan 23, 2026
@mergify

mergify Bot commented Jan 25, 2026 •

Copy link
Copy Markdown
Contributor

Merge Queue Status

✅ The pull request has been merged at 423ce6c

This pull request spent 1 hour 57 minutes 56 seconds in the queue, including 1 hour 47 minutes 35 seconds running CI.
The checks were run on draft #11463.

Required conditions to merge

mergify Bot added a commit that referenced this pull request Jan 25, 2026
@mergify
mergify Bot merged commit 2150ca5 into master Jan 25, 2026
213 of 214 checks passed
@mergify
mergify Bot deleted the wip/fix-pkgroot-haddock-html branch January 25, 2026 14:10
@mergify mergify Bot removed the queued label Jan 25, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

merge delay passed Applied (usually by Mergify) when PR approved and received no updates for 2 days merge me Tell Mergify Bot to merge ready and waiting Mergify is waiting out the cooldown period

Projects

None yet

Development

Successfully merging this pull request may close these issues.

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

5 participants