Skip to content

Commit b1b6d69

Browse files
thomcctshepang
authored andcommitted
Rename config.toml.example to config.example.toml
1 parent f9d24b3 commit b1b6d69

File tree

4 files changed

+7
-7
lines changed

4 files changed

+7
-7
lines changed

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ You can install it with `cargo install --path src/tools/x`.
4545
To start, run `./x.py setup`. This will do some initialization and create a
4646
`config.toml` for you with reasonable defaults.
4747

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

5151
If you have already built `rustc` and you change settings related to LLVM, then you may have to
@@ -188,7 +188,7 @@ Note that building for some targets requires having external dependencies instal
188188
(e.g. building musl targets requires a local copy of musl).
189189
Any target-specific configuration (e.g. the path to a local copy of musl)
190190
will need to be provided by your `config.toml`.
191-
Please see `config.toml.example` for information on target-specific configuration keys.
191+
Please see `config.example.toml` for information on target-specific configuration keys.
192192

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

src/building/suggested.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -259,8 +259,8 @@ If you're using nix, you can use the following nix-shell to work on Rust:
259259
260260
# This file contains a development shell for working on rustc.
261261
let
262-
# Build configuration for rust-lang/rust. Based on `config.toml.example` from
263-
# `1bd30ce2aac40c7698aa4a1b9520aa649ff2d1c5`.
262+
# Build configuration for rust-lang/rust. Based on `config.example.toml` (then called
263+
# `config.toml.example`) from `1bd30ce2aac40c7698aa4a1b9520aa649ff2d1c5`
264264
config = pkgs.writeText "rustc-config" ''
265265
profile = "compiler" # you may want to choose a different profile, like `library` or `tools`
266266
changelog-seen = 2
@@ -289,7 +289,7 @@ let
289289
# Files that are ignored by ripgrep when searching.
290290
ignoreFile = pkgs.writeText "rustc-rgignore" ''
291291
configure
292-
config.toml.example
292+
config.example.toml
293293
x.py
294294
LICENSE-MIT
295295
LICENSE-APACHE

src/compiler-debugging.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ otherwise you need to disable new symbol-mangling-version in `config.toml`.
4242
new-symbol-mangling = false
4343
```
4444

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

src/contributing.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -325,7 +325,7 @@ there's no need to block on tools changes going upstream.
325325
Here are those same steps in detail:
326326

327327
1. (optional) First, if it doesn't exist already, create a `config.toml` by copying
328-
`config.toml.example` in the root directory of the Rust repository.
328+
`config.example.toml` in the root directory of the Rust repository.
329329
Set `submodules = false` in the `[build]` section. This will prevent `x.py`
330330
from resetting to the original branch after you make your changes. If you
331331
need to [update any submodules to their latest versions](#updating-submodules),

0 commit comments

Comments
 (0)