diff --git a/doc/src/overrides.md b/doc/src/overrides.md index e630a109fb1..7d36e7864d6 100644 --- a/doc/src/overrides.md +++ b/doc/src/overrides.md @@ -93,12 +93,12 @@ specified. For backwards compatibility, `rust-toolchain` files also support a legacy format that only contains a toolchain name without any TOML encoding, e.g. -just `nightly-2021-01-21`. This format is not available in -`rust-toolchain.toml` files. +just `nightly-2021-01-21`. The file has to be encoded in US-ASCII this case +(if you are on Windows, check the encoding and that it does not starts with a +BOM). The legacy format is not available in `rust-toolchain.toml` files. The `rust-toolchain.toml`/`rust-toolchain` files are suitable to check in to -source control. The files have to be encoded in US-ASCII (if you are on -Windows, check the encoding and that it does not starts with a BOM). +source control. The toolchains named in these files have a more restricted form than `rustup` toolchains generally, and may only contain the names of the three release