cabal update: don't show comment with builddir in the default config #11067
Conversation
This file contains hidden or 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
ulysses4ever
added
cabal-install: cmd/update
re: config-file
sheaf
reviewed
Jul 11, 2025
geekosaur
approved these changes
Jul 11, 2025
|
Oh, whoops, there's a test that checks these (which IIRC you already pointed out to someone else?). |
|
does anyone get why CI fails? |
ulysses4ever
force-pushed
the
dont-mention-builddir-in-default-config-t11050
branch
from
5847556 to
8301c1e
Compare
sheaf
approved these changes
Jul 11, 2025
ulysses4ever
force-pushed
the
dont-mention-builddir-in-default-config-t11050
branch
2 times, most recently
from
2c86641 to
ad6dedf
Compare
|
Added changelog and manual QA notes in the PR description. |
ulysses4ever
force-pushed
the
dont-mention-builddir-in-default-config-t11050
branch
2 times, most recently
from
e65b0b5 to
0fdb5b1
Compare
When calling `cabal update` with an empty state (empty CABAL_DIR or new machine), cabal writes out a default config file with many fields commented out to show their defaults. This suggests that the user can uncomment the field and override the default. This is wrong for fields that aren't allowed in the config file like `builddir`. This patch avoids generating a comment with `builddir` in the default config. Fix #11050.
ulysses4ever
force-pushed
the
dont-mention-builddir-in-default-config-t11050
branch
from
0fdb5b1 to
a49146a
Compare
mergify
bot
added
ready and waiting
86 tasks
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.
When calling
cabal updatewith an empty state (empty CABAL_DIR or new machine), cabal writes out a default config file with many fields commented out to show their defaults. This suggests that the user can uncomment the field and override the default. This is wrong for fields that aren't allowed in the config file likebuilddir. This patch avoids generating a comment withbuilddirin the default config.Fix #11050.
Manual QA Notes
Template Α: This PR modifies behaviour or interface
Include the following checklist in your PR:
significance: significantin the changelog file.