Skip to content

Commit b3c8bf8

Browse files
authored
docs(ref): Add missing config env variables (#17345)
### What does this PR try to resolve? As identified at #17335 (comment) ### How to test and review this PR?
2 parents 94faf91 + f49eeff commit b3c8bf8

1 file changed

Lines changed: 18 additions & 0 deletions

File tree

doc/book/src/reference/environment-variables.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,7 @@ See the [configuration chapter][config-env] for more details.
8888
In summary, the supported environment variables are:
8989

9090
* `CARGO_ALIAS_<name>` --- Command aliases, see [`alias`].
91+
* `CARGO_BUILD_WARNINGS` --- The effective level of lint warnings for local packages, see [`build.warnings`].
9192
* `CARGO_BUILD_JOBS` --- Number of parallel jobs, see [`build.jobs`].
9293
* `CARGO_BUILD_RUSTC` --- The `rustc` executable, see [`build.rustc`].
9394
* `CARGO_BUILD_RUSTC_WRAPPER` --- The `rustc` wrapper, see [`build.rustc-wrapper`].
@@ -102,6 +103,7 @@ In summary, the supported environment variables are:
102103
* `CARGO_BUILD_DEP_INFO_BASEDIR` --- Dep-info relative directory, see [`build.dep-info-basedir`].
103104
* `CARGO_CACHE_AUTO_CLEAN_FREQUENCY` --- Configures how often automatic cache cleaning runs, see [`cache.auto-clean-frequency`].
104105
* `CARGO_CARGO_NEW_VCS` --- The default source control system with [`cargo new`], see [`cargo-new.vcs`].
106+
* `CARGO_CREDENTIAL_ALIAS_<name>` --- Credential provider aliases, see [`credential-alias`].
105107
* `CARGO_FUTURE_INCOMPAT_REPORT_FREQUENCY` --- How often we should generate a future incompat report notification, see [`future-incompat-report.frequency`].
106108
* `CARGO_HTTP_DEBUG` --- Enables HTTP debugging, see [`http.debug`].
107109
* `CARGO_HTTP_PROXY` --- Enables HTTP proxy, see [`http.proxy`].
@@ -132,18 +134,25 @@ In summary, the supported environment variables are:
132134
* `CARGO_REGISTRIES_<name>_CREDENTIAL_PROVIDER` --- Credential provider for a registry, see [`registries.<name>.credential-provider`].
133135
* `CARGO_REGISTRIES_<name>_INDEX` --- URL of a registry index, see [`registries.<name>.index`].
134136
* `CARGO_REGISTRIES_<name>_TOKEN` --- Authentication token of a registry, see [`registries.<name>.token`].
137+
* `CARGO_REGISTRIES_CRATES_IO_PROTOCOL` --- The protocol used to access [crates.io], see [`registries.crates-io.protocol`].
135138
* `CARGO_REGISTRY_CREDENTIAL_PROVIDER` --- Credential provider for [crates.io], see [`registry.credential-provider`].
136139
* `CARGO_REGISTRY_DEFAULT` --- Default registry for the `--registry` flag, see [`registry.default`].
137140
* `CARGO_REGISTRY_GLOBAL_CREDENTIAL_PROVIDERS` --- Credential providers for registries that do not have a specific provider defined. See [`registry.global-credential-providers`].
138141
* `CARGO_REGISTRY_TOKEN` --- Authentication token for [crates.io], see [`registry.token`].
142+
* `CARGO_RESOLVER_INCOMPATIBLE_RUST_VERSIONS` --- How incompatible Rust versions are treated during dependency resolution, see [`resolver.incompatible-rust-versions`].
143+
* `CARGO_RESOLVER_LOCKFILE_PATH` --- The path to the lockfile, see [`resolver.lockfile-path`].
139144
* `CARGO_TARGET_<triple>_LINKER` --- The linker to use, see [`target.<triple>.linker`]. The triple must be [converted to uppercase and underscores](config.md#environment-variables).
140145
* `CARGO_TARGET_<triple>_RUNNER` --- The executable runner, see [`target.<triple>.runner`].
141146
* `CARGO_TARGET_<triple>_RUSTFLAGS` --- Extra `rustc` flags for a target, see [`target.<triple>.rustflags`].
147+
* `CARGO_TARGET_<triple>_RUSTDOCFLAGS` --- Extra `rustdoc` flags for a target, see [`target.<triple>.rustdocflags`].
142148
* `CARGO_TERM_QUIET` --- Quiet mode, see [`term.quiet`].
143149
* `CARGO_TERM_VERBOSE` --- The default terminal verbosity, see [`term.verbose`].
144150
* `CARGO_TERM_COLOR` --- The default color mode, see [`term.color`].
151+
* `CARGO_TERM_HYPERLINKS` --- Whether hyperlinks are used in the terminal, see [`term.hyperlinks`].
152+
* `CARGO_TERM_UNICODE` --- Whether terminal output can use non-ASCII Unicode characters, see [`term.unicode`].
145153
* `CARGO_TERM_PROGRESS_WHEN` --- The default progress bar showing mode, see [`term.progress.when`].
146154
* `CARGO_TERM_PROGRESS_WIDTH` --- The default progress bar width, see [`term.progress.width`].
155+
* `CARGO_TERM_PROGRESS_TERM_INTEGRATION` --- Whether progress is reported to the terminal emulator, see [`term.progress.term-integration`].
147156

148157
[`cargo doc`]: ../commands/cargo-doc.md
149158
[`cargo install`]: ../commands/cargo-install.md
@@ -154,6 +163,7 @@ In summary, the supported environment variables are:
154163
[crates.io]: https://crates.io/
155164
[incremental compilation]: profiles.md#incremental
156165
[`alias`]: config.md#alias
166+
[`build.warnings`]: config.md#buildwarnings
157167
[`build.jobs`]: config.md#buildjobs
158168
[`build.rustc`]: config.md#buildrustc
159169
[`build.rustc-wrapper`]: config.md#buildrustc-wrapper
@@ -166,6 +176,7 @@ In summary, the supported environment variables are:
166176
[`build.rustdocflags`]: config.md#buildrustdocflags
167177
[`build.incremental`]: config.md#buildincremental
168178
[`build.dep-info-basedir`]: config.md#builddep-info-basedir
179+
[`credential-alias`]: config.md#credential-alias
169180
[`doc.browser`]: config.md#docbrowser
170181
[`cache.auto-clean-frequency`]: config.md#cacheauto-clean-frequency
171182
[`cargo-new.name`]: config.md#cargo-newname
@@ -198,21 +209,28 @@ In summary, the supported environment variables are:
198209
[`profile.<name>.rpath`]: config.md#profilenamerpath
199210
[`profile.<name>.split-debuginfo`]: config.md#profilenamesplit-debuginfo
200211
[`profile.<name>.strip`]: config.md#profilenamestrip
212+
[`resolver.lockfile-path`]: config.md#resolverlockfile-path
213+
[`resolver.incompatible-rust-versions`]: config.md#resolverincompatible-rust-versions
201214
[`registries.<name>.credential-provider`]: config.md#registriesnamecredential-provider
202215
[`registries.<name>.index`]: config.md#registriesnameindex
203216
[`registries.<name>.token`]: config.md#registriesnametoken
217+
[`registries.crates-io.protocol`]: config.md#registriescrates-ioprotocol
204218
[`registry.credential-provider`]: config.md#registrycredential-provider
205219
[`registry.default`]: config.md#registrydefault
206220
[`registry.global-credential-providers`]: config.md#registryglobal-credential-providers
207221
[`registry.token`]: config.md#registrytoken
208222
[`target.<triple>.linker`]: config.md#targettriplelinker
209223
[`target.<triple>.runner`]: config.md#targettriplerunner
210224
[`target.<triple>.rustflags`]: config.md#targettriplerustflags
225+
[`target.<triple>.rustdocflags`]: config.md#targettriplerustdocflags
211226
[`term.quiet`]: config.md#termquiet
212227
[`term.verbose`]: config.md#termverbose
213228
[`term.color`]: config.md#termcolor
229+
[`term.hyperlinks`]: config.md#termhyperlinks
230+
[`term.unicode`]: config.md#termunicode
214231
[`term.progress.when`]: config.md#termprogresswhen
215232
[`term.progress.width`]: config.md#termprogresswidth
233+
[`term.progress.term-integration`]: config.md#termprogressterm-integration
216234

217235
## Environment variables Cargo sets for crates
218236

0 commit comments

Comments
 (0)