Skip to content

Leave a breadcrumb towards bootstrap config documentation in bootstrap.toml #138080

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Mar 19, 2025
Merged

Leave a breadcrumb towards bootstrap config documentation in bootstrap.toml #138080

merged 1 commit into from
Mar 19, 2025

Conversation

moxian
Copy link
Contributor

@moxian moxian commented Mar 6, 2025 •
edited
Loading

I was curious as to the possible bootstrap options I can put in config.toml, but had some trouble figuring it out. There is no obvious documentation in config.toml (obviously), the documentation in src/bootstrap/defaults is nice, but also rather sparse, by design.
I had to dive into the parsing code, and stuble upon a very helpful doc comment there to realize that config.example.toml exists, and that it does, indeed, answer all of my questions.

So I figured it might be worth making this journey a bit easier for future contributors and add mention the config.example.toml directly in config.toml.

Now, since #137081 is in-flight which would rename config(.example)?.toml to bootstrap(.example)?.toml, I figure it's better to wait until that one lands, and submit the "new", "correct" filename upfront, instead of landing config.toml now and updating it to boostrap.toml later.

@rustbot blocked #137081

@rustbot
Copy link
Collaborator

rustbot commented Mar 6, 2025

r? @jieyouxu

rustbot has assigned @jieyouxu.
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) S-blocked Status: Blocked on something else such as an RFC or other implementation work. labels Mar 6, 2025
@jieyouxu jieyouxu removed the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Mar 6, 2025
@moxian moxian marked this pull request as draft March 8, 2025 10:11
@Shourya742
Copy link
Contributor

Hey @moxian, this is now unblocked.

@moxian moxian marked this pull request as ready for review March 18, 2025 04:07
@moxian
Copy link
Contributor Author

moxian commented Mar 18, 2025

@rustbot ready

@rustbot rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. and removed S-blocked Status: Blocked on something else such as an RFC or other implementation work. labels Mar 18, 2025
jieyouxu
jieyouxu approved these changes Mar 18, 2025
View reviewed changes
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

@jieyouxu
Copy link
Member

@bors r+ rollup

@bors
Copy link
Collaborator

bors commented Mar 18, 2025

📌 Commit 1be80d4 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 Mar 18, 2025
@matthiaskrgr matthiaskrgr mentioned this pull request Mar 18, 2025
Merged
bors added a commit to rust-lang-ci/rust that referenced this pull request Mar 18, 2025
@bors
Auto merge of rust-lang#138653 - matthiaskrgr:rollup-fwwqmr7, r=matth…
cd7e8c5 
…iaskrgr

Rollup of 7 pull requests

Successful merges:

 - rust-lang#136320 (exit: document interaction with C)
 - rust-lang#138080 (Leave a breadcrumb towards bootstrap config documentation in `bootstrap.toml`)
 - rust-lang#138301 (Implement `read_buf` for Hermit)
 - rust-lang#138569 (rustdoc-json: Add tests for `#[repr(...)]`)
 - rust-lang#138635 (Extract `for_each_immediate_subpat` from THIR pattern visitors)
 - rust-lang#138642 (Unvacation myself)
 - rust-lang#138644 (Add `#[cfg(test)]` for Transition in dfa in `rustc_transmute`)

r? `@ghost`
`@rustbot` modify labels: rollup
bors added a commit to rust-lang-ci/rust that referenced this pull request Mar 18, 2025
@bors
Auto merge of rust-lang#138653 - matthiaskrgr:rollup-fwwqmr7, r=matth…
eed2c22 
…iaskrgr

Rollup of 7 pull requests

Successful merges:

 - rust-lang#136320 (exit: document interaction with C)
 - rust-lang#138080 (Leave a breadcrumb towards bootstrap config documentation in `bootstrap.toml`)
 - rust-lang#138301 (Implement `read_buf` for Hermit)
 - rust-lang#138569 (rustdoc-json: Add tests for `#[repr(...)]`)
 - rust-lang#138635 (Extract `for_each_immediate_subpat` from THIR pattern visitors)
 - rust-lang#138642 (Unvacation myself)
 - rust-lang#138644 (Add `#[cfg(test)]` for Transition in dfa in `rustc_transmute`)

r? `@ghost`
`@rustbot` modify labels: rollup
bors added a commit to rust-lang-ci/rust that referenced this pull request Mar 19, 2025
@bors
Auto merge of rust-lang#138653 - matthiaskrgr:rollup-fwwqmr7, r=matth…
c4b38a5 
…iaskrgr

Rollup of 7 pull requests

Successful merges:

 - rust-lang#136320 (exit: document interaction with C)
 - rust-lang#138080 (Leave a breadcrumb towards bootstrap config documentation in `bootstrap.toml`)
 - rust-lang#138301 (Implement `read_buf` for Hermit)
 - rust-lang#138569 (rustdoc-json: Add tests for `#[repr(...)]`)
 - rust-lang#138635 (Extract `for_each_immediate_subpat` from THIR pattern visitors)
 - rust-lang#138642 (Unvacation myself)
 - rust-lang#138644 (Add `#[cfg(test)]` for Transition in dfa in `rustc_transmute`)

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit 42293e3 into rust-lang:master Mar 19, 2025
6 checks passed
@rustbot rustbot added this to the 1.87.0 milestone Mar 19, 2025
github-actions bot pushed a commit to model-checking/verify-rust-std that referenced this pull request Apr 2, 2025
@bors
Auto merge of rust-lang#138653 - matthiaskrgr:rollup-fwwqmr7, r=matth…
9d668f3 
…iaskrgr

Rollup of 7 pull requests

Successful merges:

 - rust-lang#136320 (exit: document interaction with C)
 - rust-lang#138080 (Leave a breadcrumb towards bootstrap config documentation in `bootstrap.toml`)
 - rust-lang#138301 (Implement `read_buf` for Hermit)
 - rust-lang#138569 (rustdoc-json: Add tests for `#[repr(...)]`)
 - rust-lang#138635 (Extract `for_each_immediate_subpat` from THIR pattern visitors)
 - rust-lang#138642 (Unvacation myself)
 - rust-lang#138644 (Add `#[cfg(test)]` for Transition in dfa in `rustc_transmute`)

r? `@ghost`
`@rustbot` modify labels: rollup
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jieyouxu jieyouxu jieyouxu approved these changes

+1 more reviewer

@Shourya742 Shourya742 Shourya742 approved these changes

Reviewers whose approvals may not affect merge requirements
Assignees

@jieyouxu jieyouxu

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
Milestone
1.87.0
Development

Successfully merging this pull request may close these issues.
5 participants
@moxian @rustbot @Shourya742 @jieyouxu @bors