about summary refs log tree commit diff
path: root/compiler/rustc_codegen_llvm/src
diff options
context:
space:
mode:
authorMatthias Krüger <476013+matthiaskrgr@users.noreply.github.com>2025-03-18 10:09:28 +0100
committerGitHub <noreply@github.com>2025-03-18 10:09:28 +0100
commit42293e3c68e93c9518211a56f9bfa888508888ab (patch)
treee3a912d5836cd36fbd96a7d1aa02923a0a042cef /compiler/rustc_codegen_llvm/src
parent098db784c714d8058bb1f1343e27fc7431f8f96e (diff)
parent1be80d48fa0f3fdea8dec7f05426dd619dfdf411 (diff)
downloadrust-42293e3c68e93c9518211a56f9bfa888508888ab.tar.gz
rust-42293e3c68e93c9518211a56f9bfa888508888ab.zip
Rollup merge of #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 #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
Diffstat (limited to 'compiler/rustc_codegen_llvm/src')
0 files changed, 0 insertions, 0 deletions