Skip to content

Commit 8f9fe8f

Browse files
committed
docs(user-guide): update environment-variables
1 parent fb8df25 commit 8f9fe8f

File tree

1 file changed

+13
-11
lines changed

1 file changed

+13
-11
lines changed

doc/user-guide/src/environment-variables.md

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,47 @@
11
# Environment variables
22

3-
- `RUSTUP_HOME` (default: `~/.rustup` or `%USERPROFILE%/.rustup`) Sets the
3+
- `RUSTUP_HOME` (default: `~/.rustup` or `%USERPROFILE%/.rustup`). Sets the
44
root `rustup` folder, used for storing installed toolchains and
55
configuration options.
66

7-
- `RUSTUP_TOOLCHAIN` (default: none) If set, will [override] the toolchain used
7+
- `RUSTUP_TOOLCHAIN` (default: none). If set, will [override] the toolchain used
88
for all rust tool invocations. A toolchain with this name should be installed,
99
or invocations will fail. This can specify custom toolchains, installable
1010
toolchains, or the absolute path to a toolchain.
1111

12-
- `RUSTUP_DIST_SERVER` (default: `https://static.rust-lang.org`) Sets the root
12+
- `RUSTUP_DIST_SERVER` (default: `https://static.rust-lang.org`). Sets the root
1313
URL for downloading static resources related to Rust. You can change this to
1414
instead use a local mirror, or to test the binaries from the staging
1515
directory.
1616

17-
- `RUSTUP_DIST_ROOT` (default: `https://static.rust-lang.org/dist`)
18-
Deprecated. Use `RUSTUP_DIST_SERVER` instead.
17+
- ~~`RUSTUP_DIST_ROOT`~~ *deprecated* (default: `https://static.rust-lang.org/dist`).
18+
Use `RUSTUP_DIST_SERVER` instead.
1919

20-
- `RUSTUP_UPDATE_ROOT` (default `https://static.rust-lang.org/rustup`) Sets
20+
- `RUSTUP_UPDATE_ROOT` (default `https://static.rust-lang.org/rustup`). Sets
2121
the root URL for downloading self-update.
2222

2323
- `RUSTUP_IO_THREADS` *unstable* (defaults to reported cpu count). Sets the
2424
number of threads to perform close IO in. Set to `1` to force
2525
single-threaded IO for troubleshooting, or an arbitrary number to override
2626
automatic detection.
2727

28-
- `RUSTUP_TRACE_DIR` *unstable* (default: no tracing) Enables tracing and
28+
- `RUSTUP_TRACE_DIR` *unstable* (default: no tracing). Enables tracing and
2929
determines the directory that traces will be written too. Traces are of the
3030
form PID.trace. Traces can be read by the Catapult project [tracing viewer].
3131

32-
- `RUSTUP_TERM_COLOR` (default: `auto`) Controls whether colored output is used in the terminal.
32+
- `RUSTUP_DEBUG` *unstable*. When set, enables rustup's debug logging.
33+
34+
- `RUSTUP_TERM_COLOR` (default: `auto`). Controls whether colored output is used in the terminal.
3335
Set to `auto` to use colors only in tty streams, to `always` to always enable colors,
3436
or to `never` to disable colors.
3537

36-
- `RUSTUP_UNPACK_RAM` *unstable* (default free memory or 500MiB if unable to tell, min 210MiB) Caps the amount of
38+
- `RUSTUP_UNPACK_RAM` *unstable* (default free memory or 500MiB if unable to tell, min 210MiB). Caps the amount of
3739
RAM `rustup` will use for IO tasks while unpacking.
3840

39-
- `RUSTUP_NO_BACKTRACE` Disables backtraces on non-panic errors even when
41+
- `RUSTUP_NO_BACKTRACE`. Disables backtraces on non-panic errors even when
4042
`RUST_BACKTRACE` is set.
4143

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

0 commit comments

Comments
 (0)