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

Conversation

RalfJung
Copy link
Member

Currently I go to these PRs to learn how to update my config, and then I am staring at a PR description that was clearly written for the reviewer, not the random rustc developer just updating their checkout. That's no good.

@rustbot
Copy link
Collaborator

rustbot commented Nov 11, 2023

r? @onur-ozkan

(rustbot has picked a reviewer for you, use r? to override)

@rustbot rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-bootstrap Relevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap) labels Nov 11, 2023
@Kobzol
Copy link
Contributor

Kobzol commented Nov 11, 2023

Maybe a more "enforceable" solution would be to use a struct containing a PR number and a string with config.toml modification instructions that would be printed by bootstrap? And use this struct in the array instead of just PR numbers.

@RalfJung
Copy link
Member Author

RalfJung commented Nov 11, 2023

Maybe. @onur-ozkan said they are re-thinking parts of the system anyway.

I honestly don't really want to spend time on this, I just got frustrated this morning when I got two change notifications for my config.toml and none of them told me what I should do to my config.toml in order to migrate... see discussion on Zulip. Currently this entire system is more disruptive to my rustc development than I think is appropriate.

@RalfJung
Copy link
Member Author

I also removed the duplicate printing of the changelog notice. This message is so verbose it gets in the way of regular rustc development (I can't see the output I am looking for in between all these warnings), and the message really is not important enough to justify that. (At least, the 3 times that this system was invoked so far, it really wasn't very important that everyone drop what they are doing and immediately change their config.)

Comment on lines +81 to +83
/// 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.)
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.

@onur-ozkan
Copy link
Member

onur-ozkan commented Nov 12, 2023

I also removed the duplicate printing of the changelog notice. This message is so verbose it gets in the way of regular rustc development (I can't see the output I am looking for in between all these warnings), and the message really is not important enough to justify that. (At least, the 3 times that this system was invoked so far, it really wasn't very important that everyone drop what they are doing and immediately change their config.)

Do we still need to do that? With #117815, this 2nd print becomes quite important. See #117815 (comment)

@RalfJung
Copy link
Member Author

This entire PR is superseded by #117815.

@RalfJung RalfJung closed this Nov 12, 2023
@RalfJung RalfJung deleted the bootstrap-change-history branch November 12, 2023 09:59
@onur-ozkan onur-ozkan removed the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Oct 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
T-bootstrap Relevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants