Skip to content

Do not always pass --quickjump to haddock (backport #9049) #9073

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.

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

Merged
merged 2 commits into from
Jun 30, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/whitespace.yml
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ jobs:
- name: Install fix-whitespace
if: ${{ !steps.cache.outputs.cache-hit }}
run: |
cabal install --ignore-project --install-method=copy --installdir=$HOME/.local/bin fix-whitespace-${{ env.fix-whitespace-ver }}
cabal install --constraint=aeson==2.1.2.1 --ignore-project --install-method=copy --installdir=$HOME/.local/bin fix-whitespace-${{ env.fix-whitespace-ver }}
strip $HOME/.local/bin/fix-whitespace

- name: Check the whitespace issue
Expand Down
2 changes: 1 addition & 1 deletion Cabal/src/Distribution/Simple/Haddock.hs
Original file line number Diff line number Diff line change
Expand Up @@ -709,7 +709,7 @@ renderPureArgs version comp platform args = concat
, [ "--since-qual=external" | isVersion 2 20 ]

, [ "--quickjump" | isVersion 2 19
, _ <- flagToList . argQuickJump $ args ]
, True <- flagToList . argQuickJump $ args ]

, [ "--hyperlinked-source" | isVersion 2 17
, True <- flagToList . argLinkedSource $ args ]
Expand Down
13 changes: 13 additions & 0 deletions changelog.d/pr-9049
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
synopsis: Do not always pass --quickjump to haddock #9049
packages: Cabal
prs: #9049
issues: #9060
description: {

6d8adf13101 caused `cabal` to always pass the `--quickjump` flag to Haddock.
Not only does this waste memory for a service that user hasn't asked for,
but also leads to a failure with Haddocks shipped with GHC 9.0 and 9.2,
which had a separate bug (fixed in later versions but not backported) when
Haddock does not pass `--quickjump` recursively to the package dependencies.

}