Skip to content
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

bootstrap: Add more comments to some of the test steps #135231

Merged
merged 1 commit into from
Jan 9, 2025

Conversation

Zalathar
Copy link
Contributor

@Zalathar Zalathar commented Jan 8, 2025

Some of the test steps have names that don't clearly indicate what they actually do.

While there is ongoing experimental work to actually rename the steps (e.g. #135071), that's dependent on figuring out what the new names should actually be. In the meantime, we can still improve things by adding comments to help describe the steps, which will remain useful even after any renaming.

@rustbot
Copy link
Collaborator

rustbot commented Jan 8, 2025

r? @clubby789

rustbot has assigned @clubby789.
They will have a look at your PR within the next two weeks and either review your PR or reassign to another reviewer.

Use r? to explicitly pick a reviewer

@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 Jan 8, 2025
@jieyouxu jieyouxu self-assigned this Jan 8, 2025
Copy link
Member

@jieyouxu jieyouxu left a comment

Choose a reason for hiding this comment

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

Thanks! This is very helpful 🩵

Comment on lines +1041 to +1044
/// Runs `src/tools/tidy` and `cargo fmt --check` to detect various style
/// problems in the repository.
///
/// (To run the tidy tool's internal tests, use the alias "tidyselftest" instead.)
Copy link
Member

Choose a reason for hiding this comment

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

Remark: lol

@jieyouxu
Copy link
Member

jieyouxu commented Jan 8, 2025

@bors r+ rollup

@bors
Copy link
Contributor

bors commented Jan 8, 2025

📌 Commit ceabc95 has been approved by jieyouxu

It is now in the queue for this repository.

@bors bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Jan 8, 2025
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request Jan 8, 2025
bootstrap: Add more comments to some of the test steps

Some of the test steps have names that don't clearly indicate what they actually do.

While there is ongoing experimental work to actually rename the steps (e.g. rust-lang#135071), that's dependent on figuring out what the new names should actually be. In the meantime, we can still improve things by adding comments to help describe the steps, which will remain useful even after any renaming.
bors added a commit to rust-lang-ci/rust that referenced this pull request Jan 9, 2025
…iaskrgr

Rollup of 6 pull requests

Successful merges:

 - rust-lang#128110 (Suggest Replacing Comma with Semicolon in Incorrect Repeat Expressions)
 - rust-lang#134609 (Add new `{x86_64,i686}-win7-windows-gnu` targets)
 - rust-lang#134875 (Implement `const Destruct` in old solver)
 - rust-lang#135221 (Include rustc and rustdoc book in replace-version-placeholder)
 - rust-lang#135231 (bootstrap: Add more comments to some of the test steps)
 - rust-lang#135256 (Move `mod cargo`  below the import statements)

Failed merges:

 - rust-lang#135195 (Make `lit_to_mir_constant` and `lit_to_const` infallible)

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit 07a2995 into rust-lang:master Jan 9, 2025
6 checks passed
@rustbot rustbot added this to the 1.86.0 milestone Jan 9, 2025
rust-timer added a commit to rust-lang-ci/rust that referenced this pull request Jan 9, 2025
Rollup merge of rust-lang#135231 - Zalathar:test-step-notes, r=jieyouxu

bootstrap: Add more comments to some of the test steps

Some of the test steps have names that don't clearly indicate what they actually do.

While there is ongoing experimental work to actually rename the steps (e.g. rust-lang#135071), that's dependent on figuring out what the new names should actually be. In the meantime, we can still improve things by adding comments to help describe the steps, which will remain useful even after any renaming.
@Zalathar Zalathar deleted the test-step-notes branch January 9, 2025 08:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. 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.

5 participants