Skip to content

Document online Setup.hs haddock --for-hackage #11325

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
mergify merged 1 commit into from
Jan 20, 2026
Merged

Document online Setup.hs haddock --for-hackage #11325

mergify merged 1 commit into from
Jan 20, 2026
+25 −0

Conversation

@mpilgrem
Copy link
Collaborator

@mpilgrem mpilgrem commented Dec 4, 2025

About 10 years ago, Cabal added the --for-hackage flag:

This pull request seeks to document it online.

In order to do so, it also documents the undocumented --html, --contents-location=url, and --quickjump flags, based on their in-app documentation and that for similar documented fields.

  • 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). N/A

@Bodigrim
Copy link
Collaborator

Bodigrim commented Jan 18, 2026

@mpilgrem would you like to assign "merge me" label?

@mpilgrem mpilgrem added the merge me Tell Mergify Bot to merge label Jan 18, 2026
@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 18, 2026
@mergify
Copy link
Contributor

mergify bot commented Jan 20, 2026 •
edited
Loading

Merge Queue Status

✅ The pull request has been merged at a555ef2

This pull request spent 2 hours 7 minutes 26 seconds in the queue, including 1 hour 56 minutes 28 seconds running CI.
The checks were run on draft #11447.

Required conditions to merge
  • #approved-reviews-by >= 2 [🛡 GitHub branch protection]
  • #changes-requested-reviews-by = 0 [🛡 GitHub branch protection]
  • #review-threads-unresolved = 0 [🛡 GitHub branch protection]
  • any of [🛡 GitHub branch protection]:
    • check-success = Doctest Cabal
    • check-neutral = Doctest Cabal
    • check-skipped = Doctest Cabal
  • any of [🛡 GitHub branch protection]:
    • check-success = Meta checks
    • check-neutral = Meta checks
    • check-skipped = Meta checks
  • any of [🛡 GitHub branch protection]:
    • check-success = docs/readthedocs.org:cabal
    • check-neutral = docs/readthedocs.org:cabal
    • check-skipped = docs/readthedocs.org:cabal
  • any of [🛡 GitHub branch protection]:
    • check-success = Validate post job
    • check-neutral = Validate post job
    • check-skipped = Validate post job
  • any of [🛡 GitHub branch protection]:
    • check-success = fourmolu
    • check-neutral = fourmolu
    • check-skipped = fourmolu
  • any of [🛡 GitHub branch protection]:
    • check-success = hlint
    • check-neutral = hlint
    • check-skipped = hlint
  • any of [🛡 GitHub branch protection]:
    • check-success = Bootstrap post job
    • check-neutral = Bootstrap post job
    • check-skipped = Bootstrap post job
  • any of [🛡 GitHub branch protection]:
    • check-success = whitespace
    • check-neutral = whitespace
    • check-skipped = whitespace
  • any of [🛡 GitHub branch protection]:
    • check-success = Check sdist post job
    • check-neutral = Check sdist post job
    • check-skipped = Check sdist post job
  • any of [🛡 GitHub branch protection]:
    • check-success = Changelogs
    • check-neutral = Changelogs
    • check-skipped = Changelogs

mergify bot added a commit that referenced this pull request Jan 20, 2026
@mergify
Merge of #11325
d3d30c5
@mergify mergify bot mentioned this pull request Jan 20, 2026
Closed
86 tasks
@mergify mergify bot merged commit a825902 into master Jan 20, 2026
244 of 246 checks passed
@mergify mergify bot deleted the for-hackage-docs branch January 20, 2026 21:51
@mergify mergify bot removed the queued label Jan 20, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@geekosaur geekosaur geekosaur approved these changes

@Bodigrim Bodigrim Bodigrim approved these changes

Assignees

No one assigned

Labels

documentation 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

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@mpilgrem @Bodigrim @geekosaur