Skip to content

Commit 42293e3

Browse files
authored
Rollup merge of rust-lang#138080 - moxian:bootstrap-breadcrumb, r=jieyouxu
Leave a breadcrumb towards bootstrap config documentation in `bootstrap.toml` 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](https://github.com/rust-lang/rust/blob/30f168ef811aec63124eac677e14699baa9395bd/src/bootstrap/src/core/config/config.rs#L181) 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 rust-lang#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 rust-lang#137081
2 parents 098db78 + 1be80d4 commit 42293e3

File tree

1 file changed

+3
-2
lines changed
  • src/bootstrap/src/core/build_steps

1 file changed

+3
-2
lines changed

src/bootstrap/src/core/build_steps/setup.rs

+3-2
Original file line numberDiff line numberDiff line change
@@ -214,8 +214,9 @@ fn setup_config_toml(path: &Path, profile: Profile, config: &Config) {
214214

215215
let latest_change_id = CONFIG_CHANGE_HISTORY.last().unwrap().change_id;
216216
let settings = format!(
217-
"# Includes one of the default files in {PROFILE_DIR}\n\
218-
profile = \"{profile}\"\n\
217+
"# See bootstrap.example.toml for documentation of available options\n\
218+
#\n\
219+
profile = \"{profile}\" # Includes one of the default files in {PROFILE_DIR}\n\
219220
change-id = {latest_change_id}\n"
220221
);
221222

0 commit comments

Comments
 (0)