Skip to content

bootstrap: please document why a config change requires migration #117809

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

Closed
wants to merge 2 commits into from
Closed
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
4 changes: 1 addition & 3 deletions src/bootstrap/src/bin/main.rs
Original file line number Diff line number Diff line change
Expand Up @@ -79,8 +79,6 @@ fn main() {
"HELP: consider running `./x.py setup` or copying `config.example.toml` by running \
`cp config.example.toml config.toml`"
);
} else if let Some(suggestion) = &changelog_suggestion {
println!("{suggestion}");
}

// Give a warning if the pre-commit script is in pre-commit and not pre-push.
Expand All @@ -96,7 +94,7 @@ fn main() {
);
}

if suggest_setup || changelog_suggestion.is_some() {
if suggest_setup {
println!("NOTE: this message was printed twice to make it more likely to be seen");
}
}
Expand Down
3 changes: 3 additions & 0 deletions src/bootstrap/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,9 @@ const LLD_FILE_NAMES: &[&str] = &["ld.lld", "ld64.lld", "lld-link", "wasm-ld"];
/// If you make any major changes (such as adding new values or changing default values),
/// please ensure that the associated PR ID is added to the end of this list.
/// This is necessary because the list must be sorted by the merge date.
/// Also make sure that your PR description tells people what they need to do
/// to migrate their configuration. (If there's nothing to migrate, consider whether
/// having *every rustc developer* open your PR page is really necessary.)
Comment on lines +81 to +83
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As #117815 aims to fix this problem, this change shouldn't be needed anymore.

pub const CONFIG_CHANGE_HISTORY: &[usize] = &[115898, 116998, 117435, 116881];

/// Extra --check-cfg to add when building
Expand Down