Skip to content

Document "invalid channel name '[toolchain]'" error #2697

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Mar 23, 2021
Merged

Document "invalid channel name '[toolchain]'" error #2697

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e1d7030
Document "invalid channel name '[toolchain]'" error
jstasiak Mar 21, 2021
e872da3
Apply code review feedback and fix an incorrect statement
jstasiak Mar 21, 2021
f58a414
Improve the wording
jstasiak Mar 23, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion doc/src/overrides.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Overrides
[[#]] Overrides

`rustup` automatically determines which [toolchain] to use when one of the
installed commands like `rustc` is executed. There are several ways to control
Expand Down Expand Up @@ -97,6 +97,16 @@ 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 start with a
BOM). The legacy format is not available in `rust-toolchain.toml` files.

If you see the following error (when running `rustc`, `cargo` or other command)

```
error: invalid channel name '[toolchain]' in '/PATH/TO/DIRECTORY/rust-toolchain'
```

it means you're running `rustup` pre-1.23.0 and trying to interact with a project
that uses the new TOML encoding in the `rust-toolchain` file. You need to upgrade
`rustup` to 1.23.0+.

The `rust-toolchain.toml`/`rust-toolchain` files are suitable to check in to
source control.

Expand Down