Fix assertion failure when combining build-tool-depends and --enable-documentation #9446
Conversation
This file contains 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
mpickering
force-pushed
the
wip/t6006
branch
4 times, most recently
from
cc7f455 to
b519ddf
Compare
Mikolaj
requested changes
Nov 15, 2023
mpickering
force-pushed
the
wip/t6006
branch
from
b519ddf to
6ebb279
Compare
|
BTW, the CI failure looks like a server filesystem or network issue, so let me rebase to restart it... |
|
@mergify rebase |
✅ Branch has been successfully rebased |
mpickering
force-pushed
the
wip/t6006
branch
from
75ea384 to
82afa90
Compare
|
I accidentally force pushed to the wrong branch, should be fixed now. |
gbaz
approved these changes
Nov 17, 2023
|
Time for the merge label? |
mergify
bot
added
the
merge delay passed
|
This got stuck due to changes CI mandatory tests rule. Rebasing... |
|
@mergify rebase |
✅ Branch has been successfully rebased |
…documentation The `setDocumentation` function was modifying the elaborated package after the hash was computed. This led to the assertion failing as the computed hash was different to what was computed in the initial install plan. Therefore in order to fix this we either needed to: 1. Set elabBuildHaddocks = False at the point where the hash is initially computed. 2. Verify that elabBuildHaddocks = True will not lead to unexpected results. The latter has been implemented. The elabBuildHaddocks option is only consulted in `hasValidHaddockTargets`, at which point documentation building the executable component is disabled because elabHaddockExecutables is False. In the added test we ensure this by checking that we didn't build documentation for the executable which is built because of build-tool-depends. Fixes haskell#6006 haskell#8313
andreasabel
added
re: build-tool
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Fix assertion failure when combining build-tool-depends and --enable-documentation
The
setDocumentationfunction was modifying the elaborated packageafter the hash was computed. This led to the assertion failing as the
computed hash was different to what was computed in the initial install
plan.
Therefore in order to fix this we either needed to:
. Set elabBuildHaddocks = False at the point where the hash is
initially computed.
2 Verify that elabBuildHaddocks = True will not lead to unexpected
results.
The latter has been implemented.
The elabBuildHaddocks option is only consulted in
hasValidHaddockTargets, at which point documentation building theexecutable component is disabled because elabHaddockExecutables is
False.
In the added test we ensure this by checking that we didn't build
documentation for the executable which is built because of
build-tool-depends.
Fixes #6006 #8313