Skip to content

Commit 6c429e9

Browse files
author
Jon Gjengset
committed
Clearer docs for path
1 parent abf9bce commit 6c429e9

File tree

1 file changed

+13
-6
lines changed

1 file changed

+13
-6
lines changed

doc/src/overrides.md

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -83,9 +83,6 @@ a directory, the latter is used for backwards compatibility. The files use the
8383
``` toml
8484
[toolchain]
8585
channel = "nightly-2020-07-10"
86-
# or
87-
path = "/path/to/local/toolchain"
88-
8986
components = [ "rustfmt", "rustc-dev" ]
9087
targets = [ "wasm32-unknown-unknown", "thumbv2-none-eabi" ]
9188
profile = "minimal"
@@ -107,9 +104,19 @@ The toolchains named in these files have a more restricted form than `rustup`
107104
toolchains generally, and may only contain the names of the three release
108105
channels, 'stable', 'beta', 'nightly', Rust version numbers, like '1.0.0', and
109106
optionally an archive date, like 'nightly-2017-01-01'. They may not name
110-
custom toolchains, nor host-specific toolchains, except by giving the
111-
`path` to said toolchain directly. A relative `path` is resolved
112-
relative to the location of the `rust-toolchain.toml` file.
107+
custom toolchains, nor host-specific toolchains. To use a custom local
108+
toolchain, you can instead use a `path` toolchain:
109+
110+
``` toml
111+
[toolchain]
112+
path = "/path/to/local/toolchain"
113+
```
114+
115+
Since a `path` directive directly names a local toolchain, other options
116+
like `components`, `targets`, and `profile` have no effect. `channel`
117+
and `path` are mutually exclusive, since a `path` already points to a
118+
specific toolchain. A relative `path` is resolved relative to the
119+
location of the `rust-toolchain.toml` file.
113120

114121
## Default toolchain
115122

0 commit comments

Comments
 (0)