Skip to content

Commit 7f6a7ce

Browse files
author
default
committed
rename config.toml to bootstrap.toml
1 parent 0a92516 commit 7f6a7ce

23 files changed

+52
-52
lines changed

src/backend/debugging.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ which means that LLVM assertion failures can show up as compiler crashes (not
3838
ICEs but "real" crashes) and other sorts of weird behavior. If you are
3939
encountering these, it is a good idea to try using a compiler with LLVM
4040
assertions enabled - either an "alt" nightly or a compiler you build yourself
41-
by setting `[llvm] assertions=true` in your config.toml - and see whether
41+
by setting `[llvm] assertions=true` in your bootstrap.toml - and see whether
4242
anything turns up.
4343

4444
The rustc build process builds the LLVM tools into
@@ -160,7 +160,7 @@ from `./build/<host-triple>/llvm/bin/` with the LLVM IR emitted by rustc.
160160
When investigating the implementation of LLVM itself, you should be
161161
aware of its [internal debug infrastructure][llvm-debug].
162162
This is provided in LLVM Debug builds, which you enable for rustc
163-
LLVM builds by changing this setting in the config.toml:
163+
LLVM builds by changing this setting in the bootstrap.toml:
164164
```
165165
[llvm]
166166
# Indicates whether the LLVM assertions are enabled or not

src/backend/updating-llvm.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ so let's go through each in detail.
101101
Note that `profile = "compiler"` and other defaults set by `./x setup`
102102
download LLVM from CI instead of building it from source.
103103
You should disable this temporarily to make sure your changes are being used.
104-
This is done by having the following setting in `config.toml`:
104+
This is done by having the following setting in `bootstrap.toml`:
105105

106106
```toml
107107
[llvm]

src/building/compiler-documenting.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ like the standard library (std) or the compiler (rustc).
3636
- Document internal rustc items
3737

3838
Compiler documentation is not built by default.
39-
To create it by default with `x doc`, modify `config.toml`:
39+
To create it by default with `x doc`, modify `bootstrap.toml`:
4040

4141
```toml
4242
[build]

src/building/how-to-build-and-run.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -139,15 +139,15 @@ similar to the one declared in section [What is `x.py`](#what-is-xpy), but
139139
it works as an independent process to execute the `x.py` rather than calling the
140140
shell to run the platform related scripts.
141141

142-
## Create a `config.toml`
142+
## Create a `bootstrap.toml`
143143

144144
To start, run `./x setup` and select the `compiler` defaults. This will do some initialization
145-
and create a `config.toml` for you with reasonable defaults. If you use a different default (which
145+
and create a `bootstrap.toml` for you with reasonable defaults. If you use a different default (which
146146
you'll likely want to do if you want to contribute to an area of rust other than the compiler, such
147147
as rustdoc), make sure to read information about that default (located in `src/bootstrap/defaults`)
148148
as the build process may be different for other defaults.
149149

150-
Alternatively, you can write `config.toml` by hand. See `config.example.toml` for all the available
150+
Alternatively, you can write `bootstrap.toml` by hand. See `bootstrap.example.toml` for all the available
151151
settings and explanations of them. See `src/bootstrap/defaults` for common settings to change.
152152

153153
If you have already built `rustc` and you change settings related to LLVM, then you may have to
@@ -186,7 +186,7 @@ See the chapters on
186186
Note that building will require a relatively large amount of storage space.
187187
You may want to have upwards of 10 or 15 gigabytes available to build the compiler.
188188

189-
Once you've created a `config.toml`, you are now ready to run
189+
Once you've created a `bootstrap.toml`, you are now ready to run
190190
`x`. There are a lot of options here, but let's start with what is
191191
probably the best "go to" command for building a local compiler:
192192

@@ -306,7 +306,7 @@ involve proc macros or build scripts, you must be sure to explicitly build targe
306306
host platform (in this case, `x86_64-unknown-linux-gnu`).
307307

308308
If you want to always build for other targets without needing to pass flags to `x build`,
309-
you can configure this in the `[build]` section of your `config.toml` like so:
309+
you can configure this in the `[build]` section of your `bootstrap.toml` like so:
310310

311311
```toml
312312
[build]
@@ -316,8 +316,8 @@ target = ["x86_64-unknown-linux-gnu", "wasm32-wasip1"]
316316
Note that building for some targets requires having external dependencies installed
317317
(e.g. building musl targets requires a local copy of musl).
318318
Any target-specific configuration (e.g. the path to a local copy of musl)
319-
will need to be provided by your `config.toml`.
320-
Please see `config.example.toml` for information on target-specific configuration keys.
319+
will need to be provided by your `bootstrap.toml`.
320+
Please see `bootstrap.example.toml` for information on target-specific configuration keys.
321321

322322
For examples of the complete configuration necessary to build a target, please visit
323323
[the rustc book](https://doc.rust-lang.org/rustc/platform-support.html),

src/building/new-target.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ able to configure Rust to treat your build as the system LLVM to avoid
3333
redundant builds.
3434

3535
You can tell Rust to use a pre-built version of LLVM using the `target` section
36-
of `config.toml`:
36+
of `bootstrap.toml`:
3737

3838
```toml
3939
[target.x86_64-unknown-linux-gnu]
@@ -51,8 +51,8 @@ for codegen tests. This tool is normally built with LLVM, but if you use your
5151
own preinstalled LLVM, you will need to provide `FileCheck` in some other way.
5252
On Debian-based systems, you can install the `llvm-N-tools` package (where `N`
5353
is the LLVM version number, e.g. `llvm-8-tools`). Alternately, you can specify
54-
the path to `FileCheck` with the `llvm-filecheck` config item in `config.toml`
55-
or you can disable codegen test with the `codegen-tests` item in `config.toml`.
54+
the path to `FileCheck` with the `llvm-filecheck` config item in `bootstrap.toml`
55+
or you can disable codegen test with the `codegen-tests` item in `bootstrap.toml`.
5656

5757
## Creating a target specification
5858

@@ -137,7 +137,7 @@ After this, run `cargo update -p libc` to update the lockfiles.
137137

138138
Beware that if you patch to a local `path` dependency, this will enable
139139
warnings for that dependency. Some dependencies are not warning-free, and due
140-
to the `deny-warnings` setting in `config.toml`, the build may suddenly start
140+
to the `deny-warnings` setting in `bootstrap.toml`, the build may suddenly start
141141
to fail. To work around the warnings, you may want to disable `deny-warnings`
142142
in the config, or modify the dependency to remove the warnings.
143143

src/building/optimized-build.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ This page describes how you can use these approaches when building `rustc` yours
1313

1414
Link-time optimization is a powerful compiler technique that can increase program performance. To
1515
enable (Thin-)LTO when building `rustc`, set the `rust.lto` config option to `"thin"`
16-
in `config.toml`:
16+
in `bootstrap.toml`:
1717

1818
```toml
1919
[rust]
@@ -34,7 +34,7 @@ Enabling LTO on Linux has [produced] speed-ups by up to 10%.
3434

3535
Using a different memory allocator for `rustc` can provide significant performance benefits. If you
3636
want to enable the `jemalloc` allocator, you can set the `rust.jemalloc` option to `true`
37-
in `config.toml`:
37+
in `bootstrap.toml`:
3838

3939
```toml
4040
[rust]
@@ -46,7 +46,7 @@ jemalloc = true
4646
## Codegen units
4747

4848
Reducing the amount of codegen units per `rustc` crate can produce a faster build of the compiler.
49-
You can modify the number of codegen units for `rustc` and `libstd` in `config.toml` with the
49+
You can modify the number of codegen units for `rustc` and `libstd` in `bootstrap.toml` with the
5050
following options:
5151

5252
```toml
@@ -67,7 +67,7 @@ RUSTFLAGS="-C target_cpu=x86-64-v3" ./x build ...
6767
```
6868

6969
If you also want to compile LLVM for a specific instruction set, you can set `llvm` flags
70-
in `config.toml`:
70+
in `bootstrap.toml`:
7171

7272
```toml
7373
[llvm]

src/building/prerequisites.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,4 +38,4 @@ incremental compilation ([see here][config]). This will make compilation take
3838
longer (especially after a rebase), but will save a ton of space from the
3939
incremental caches.
4040

41-
[config]: ./how-to-build-and-run.md#create-a-configtoml
41+
[config]: ./how-to-build-and-run.md#create-a-bootstraptoml

src/building/suggested.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -207,7 +207,7 @@ time in subsequent rebuilds:
207207
```
208208

209209
If you don't want to include the flag with every command, you can
210-
enable it in the `config.toml`:
210+
enable it in the `bootstrap.toml`:
211211

212212
```toml
213213
[rust]
@@ -293,20 +293,20 @@ pkgs.mkShell {
293293
```
294294

295295
Note that when using nix on a not-NixOS distribution, it may be necessary to set
296-
**`patch-binaries-for-nix = true` in `config.toml`**.
296+
**`patch-binaries-for-nix = true` in `bootstrap.toml`**.
297297
Bootstrap tries to detect whether it's running in nix and enable patching automatically,
298298
but this detection can have false negatives.
299299

300-
You can also use your nix shell to manage `config.toml`:
300+
You can also use your nix shell to manage `bootstrap.toml`:
301301

302302
```nix
303303
let
304304
config = pkgs.writeText "rustc-config" ''
305-
# Your config.toml content goes here
305+
# Your bootstrap.toml content goes here
306306
''
307307
pkgs.mkShell {
308308
/* ... */
309-
# This environment variable tells bootstrap where our config.toml is.
309+
# This environment variable tells bootstrap where our bootstrap.toml is.
310310
RUST_BOOTSTRAP_CONFIG = config;
311311
}
312312
```

src/compiler-debugging.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,13 @@ chapter](./backend/debugging.md)).
1111
## Configuring the compiler
1212

1313
By default, rustc is built without most debug information. To enable debug info,
14-
set `debug = true` in your config.toml.
14+
set `debug = true` in your bootstrap.toml.
1515

1616
Setting `debug = true` turns on many different debug options (e.g., `debug-assertions`,
1717
`debug-logging`, etc.) which can be individually tweaked if you want to, but many people
1818
simply set `debug = true`.
1919

20-
If you want to use GDB to debug rustc, please set `config.toml` with options:
20+
If you want to use GDB to debug rustc, please set `bootstrap.toml` with options:
2121

2222
```toml
2323
[rust]
@@ -35,14 +35,14 @@ debuginfo-level = 2
3535
3636
The default configuration will enable `symbol-mangling-version` v0.
3737
This requires at least GDB v10.2,
38-
otherwise you need to disable new symbol-mangling-version in `config.toml`.
38+
otherwise you need to disable new symbol-mangling-version in `bootstrap.toml`.
3939

4040
```toml
4141
[rust]
4242
new-symbol-mangling = false
4343
```
4444

45-
> See the comments in `config.example.toml` for more info.
45+
> See the comments in `bootstrap.example.toml` for more info.
4646
4747
You will need to rebuild the compiler after changing any configuration option.
4848

@@ -335,7 +335,7 @@ error: aborting due to previous error
335335

336336
## Configuring CodeLLDB for debugging `rustc`
337337

338-
If you are using VSCode, and have edited your `config.toml` to request debugging
338+
If you are using VSCode, and have edited your `bootstrap.toml` to request debugging
339339
level 1 or 2 for the parts of the code you're interested in, then you should be
340340
able to use the [CodeLLDB] extension in VSCode to debug it.
341341

src/fuzzing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ what actually results in superior throughput.
123123
You may want to build rustc from source with debug assertions to find
124124
additional bugs, though this is a trade-off: it can slow down fuzzing by
125125
requiring extra work for every execution. To enable debug assertions, add this
126-
to `config.toml` when compiling rustc:
126+
to `bootstrap.toml` when compiling rustc:
127127

128128
```toml
129129
[rust]

0 commit comments

Comments
 (0)