Skip to content

Re-add unreleased documentation. #2483

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
kinnison merged 1 commit into from
Sep 9, 2020
Merged

Re-add unreleased documentation. #2483

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 7 additions & 0 deletions doc/src/environment-variables.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,5 +34,12 @@
- `RUSTUP_NO_BACKTRACE` Disables backtraces on non-panic errors even when
`RUST_BACKTRACE` is set.

- `RUSTUP_PERMIT_COPY_RENAME` *unstable* When set, allows rustup to fall-back
to copying files if attempts to `rename` result in an cross-device link
errors. These errors occur on OverlayFS, which is used by [Docker][dc]. This
feature sacrifices some transactions protections and may be removed at any
point. Linux only.

[dc]: https://docs.docker.com/storage/storagedriver/overlayfs-driver/#modifying-files-or-directories
[override]: overrides.md
[tracing viewer]: https://github.com/catapult-project/catapult/blob/master/tracing/README.md
20 changes: 16 additions & 4 deletions doc/src/overrides.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,10 +74,22 @@ case for nightly-only software that pins to a revision from the release
archives.

In these cases the toolchain can be named in the project's directory in a file
called `rust-toolchain`, the content of which is the name of a single `rustup`
toolchain, and which is suitable to check in to source control. This file has
to be encoded in US-ASCII (if you are on Windows, check the encoding and that
it does not starts with a BOM).
called `rust-toolchain`, the content of which is either the name of a single
`rustup` toolchain, or a TOML file with the following layout:

``` toml
[toolchain]
channel = "nightly-2020-07-10"
components = [ "rustfmt", "rustc-dev" ]
targets = [ "wasm32-unknown-unknown", "thumbv2-none-eabi" ]
```

If the TOML format is used, the `[toolchain]` section is mandatory, and at
least one property must be specified.

The `rust-toolchain` file is suitable to check in to source control. This file
has to be encoded in US-ASCII (if you are on Windows, check the encoding and
that it does not starts with a BOM).

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