Leave a breadcrumb towards bootstrap config documentation in bootstrap.toml
#138080
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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 inconfig.toml
.Now, since #137081 is in-flight which would rename
config(.example)?.toml
tobootstrap(.example)?.toml
, I figure it's better to wait until that one lands, and submit the "new", "correct" filename upfront, instead of landingconfig.toml
now and updating it toboostrap.toml
later.@rustbot blocked #137081