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

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

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

moxian
Copy link
Contributor

@moxian moxian commented Mar 6, 2025

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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S-blocked Status: Blocked on something else such as an RFC or other implementation work. 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.

3 participants