Skip to content

Commit 90f5f55

Browse files
authored
rename rust-toolchain to rust-toolchain.toml (#14442)
The configuration of the toolchain using `rust-toolchain` is only retained for backward compatibility, and it is recommended to explicitly specify the TOML format, as in `rust-toolchain.toml`. r? flip1995 (This is because the change affects the sync process, and you are the one responsible for sync (I believe).) changelog: none
2 parents 1e5237f + 19c7c46 commit 90f5f55

File tree

6 files changed

+5
-5
lines changed

6 files changed

+5
-5
lines changed

book/src/development/basics.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,7 @@ following:
147147

148148
First, take note of the toolchain
149149
[override](https://rust-lang.github.io/rustup/overrides.html) in
150-
`/rust-toolchain`. We will use this override to install Clippy into the right
150+
`/rust-toolchain.toml`. We will use this override to install Clippy into the right
151151
toolchain.
152152

153153
> Tip: You can view the active toolchain for the current directory with `rustup

book/src/development/infrastructure/sync.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ to be run inside the `rust` directory):
8686
4. Bump the nightly version in the Clippy repository by running these commands:
8787
```bash
8888
cargo dev sync update_nightly
89-
git commit -m "Bump nightly version -> YYYY-MM-DD" rust-toolchain clippy_utils/README.md
89+
git commit -m "Bump nightly version -> YYYY-MM-DD" rust-toolchain.toml clippy_utils/README.md
9090
```
9191
5. Open a PR to `rust-lang/rust-clippy` and wait for it to get merged (to
9292
accelerate the process ping the `@rust-lang/clippy` team in your PR and/or

clippy_dev/src/main.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -334,7 +334,7 @@ struct SyncCommand {
334334
#[derive(Subcommand)]
335335
enum SyncSubcommand {
336336
#[command(name = "update_nightly")]
337-
/// Update nightly version in rust-toolchain and `clippy_utils`
337+
/// Update nightly version in `rust-toolchain.toml` and `clippy_utils`
338338
UpdateNightly,
339339
}
340340

clippy_dev/src/setup/toolchain.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ pub fn create(standalone: bool, force: bool, release: bool, name: &str) {
6262

6363
println!("Created toolchain {name}, use it in other projects with e.g. `cargo +{name} clippy`");
6464
if !standalone {
65-
println!("Note: This will need to be re-run whenever the Clippy `rust-toolchain` changes");
65+
println!("Note: This will need to be re-run whenever the Clippy `rust-toolchain.toml` changes");
6666
}
6767
}
6868

clippy_dev/src/sync.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ pub fn update_nightly() {
1010
let date = Utc::now().format("%Y-%m-%d").to_string();
1111
replace_region_in_file(
1212
UpdateMode::Change,
13-
Path::new("rust-toolchain"),
13+
Path::new("rust-toolchain.toml"),
1414
"# begin autogenerated nightly\n",
1515
"# end autogenerated nightly",
1616
|res| {
File renamed without changes.

0 commit comments

Comments
 (0)