Skip to content

Commit

Permalink
Only the legacy format needs to be US-ASCII
Browse files Browse the repository at this point in the history
  • Loading branch information
phil-opp committed Feb 21, 2021
1 parent 21f7228 commit 0285773
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions doc/src/overrides.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 0285773

Please sign in to comment.