Skip to content

Commit 028124b

Browse files
committed
Re-add unreleased documentation.
1 parent c89d1ed commit 028124b

File tree

2 files changed

+23
-4
lines changed

2 files changed

+23
-4
lines changed

doc/src/environment-variables.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,5 +34,12 @@
3434
- `RUSTUP_NO_BACKTRACE` Disables backtraces on non-panic errors even when
3535
`RUST_BACKTRACE` is set.
3636

37+
- `RUSTUP_PERMIT_COPY_RENAME` *unstable* When set, allows rustup to fall-back
38+
to copying files if attempts to `rename` result in an cross-device link
39+
errors. These errors occur on OverlayFS, which is used by [Docker][dc]. This
40+
feature sacrifices some transactions protections and may be removed at any
41+
point. Linux only.
42+
43+
[dc]: https://docs.docker.com/storage/storagedriver/overlayfs-driver/#modifying-files-or-directories
3744
[override]: overrides.md
3845
[tracing viewer]: https://github.com/catapult-project/catapult/blob/master/tracing/README.md

doc/src/overrides.md

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -74,10 +74,22 @@ case for nightly-only software that pins to a revision from the release
7474
archives.
7575

7676
In these cases the toolchain can be named in the project's directory in a file
77-
called `rust-toolchain`, the content of which is the name of a single `rustup`
78-
toolchain, and which is suitable to check in to source control. This file has
79-
to be encoded in US-ASCII (if you are on Windows, check the encoding and that
80-
it does not starts with a BOM).
77+
called `rust-toolchain`, the content of which is either the name of a single
78+
`rustup` toolchain, or a TOML file with the following layout:
79+
80+
``` toml
81+
[toolchain]
82+
channel = "nightly-2020-07-10"
83+
components = [ "rustfmt", "rustc-dev" ]
84+
targets = [ "wasm32-unknown-unknown", "thumbv2-none-eabi" ]
85+
```
86+
87+
If the TOML format is used, the `[toolchain]` section is mandatory, and at
88+
least one property must be specified.
89+
90+
The `rust-toolchain` file is suitable to check in to source control. This file
91+
has to be encoded in US-ASCII (if you are on Windows, check the encoding and
92+
that it does not starts with a BOM).
8193

8294
The toolchains named in this file have a more restricted form than `rustup`
8395
toolchains generally, and may only contain the names of the three release

0 commit comments

Comments
 (0)