bootstrap: emit hint if a config key is used in the wrong section #146611
+54
−11
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
|
This PR modifies If appropriate, please update |
rustbot
added
S-waiting-on-review
lolbinarycat
force-pushed
the
bootstrap-toml-wrong-section-diagnostic
branch
from
e85f09f to
2593762
Compare
Kobzol
reviewed
Sep 16, 2025
| } | ||
|
|
||
| fn find_correct_section_for_field(field_name: &str) -> Vec<&'static str> { | ||
| let sections = ["<top level>", "build", "install", "llvm", "gcc", "rust", "dist"]; |
There was a problem hiding this comment.
We actually have a field named build, so for that this heuristic wouldn't work, but that's not so important.
There was a problem hiding this comment.
The code could easily be generalized to detect when a section name is also valid as a key in a given section, but the problem is I have no idea what a good diagnostic to print in that case would be.
| exit!(2); | ||
| } | ||
|
|
||
| fn find_correct_section_for_field(field_name: &str) -> Vec<&'static str> { |
There was a problem hiding this comment.
Could you please use an enum rather than a string reference here?
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.
based on discussion on #146591
now, if the user puts
build.download-rustcinbootstrap.toml, they'll get a diagnostic:hint: try moving `download-rustc` to the `rust` sectionand if they nest things too much (
rust.rust.download-rustc):hint: section name `rust` used as a key within a sectionif they specify a top-level key within a section (
rust.profile):hint: try using `profile` as a top level keyr? @Kobzol