From 26a499b98401900fc347b7ad6500fc7fdc35016b Mon Sep 17 00:00:00 2001 From: hi-rustin Date: Thu, 5 May 2022 22:24:10 +0800 Subject: [PATCH] Improve CARGO_ENCODED_RUSTFLAGS and CARGO_ENCODED_RUSTDOCFLAGS variables docs Signed-off-by: hi-rustin --- src/doc/src/reference/config.md | 16 +++++++++------- src/doc/src/reference/environment-variables.md | 14 ++++++++------ 2 files changed, 17 insertions(+), 13 deletions(-) diff --git a/src/doc/src/reference/config.md b/src/doc/src/reference/config.md index 235ef143f0b..9ee0a58c34c 100644 --- a/src/doc/src/reference/config.md +++ b/src/doc/src/reference/config.md @@ -363,7 +363,7 @@ Can be overridden with the `--target-dir` CLI option. ##### `build.rustflags` * Type: string or array of strings * Default: none -* Environment: `CARGO_BUILD_RUSTFLAGS` or `RUSTFLAGS` +* Environment: `CARGO_BUILD_RUSTFLAGS` or `CARGO_ENCODED_RUSTFLAGS` or `RUSTFLAGS` Extra command-line flags to pass to `rustc`. The value may be a array of strings or a space-separated string. @@ -371,10 +371,11 @@ strings or a space-separated string. There are three mutually exclusive sources of extra flags. They are checked in order, with the first one being used: -1. `RUSTFLAGS` environment variable. -2. All matching `target..rustflags` and `target..rustflags` +1. `CARGO_ENCODED_RUSTFLAGS` environment variable. +2. `RUSTFLAGS` environment variable. +3. All matching `target..rustflags` and `target..rustflags` config entries joined together. -3. `build.rustflags` config value. +4. `build.rustflags` config value. Additional flags may also be passed with the [`cargo rustc`] command. @@ -399,7 +400,7 @@ appropriate profile setting. ##### `build.rustdocflags` * Type: string or array of strings * Default: none -* Environment: `CARGO_BUILD_RUSTDOCFLAGS` or `RUSTDOCFLAGS` +* Environment: `CARGO_BUILD_RUSTDOCFLAGS` or `CARGO_ENCODED_RUSTDOCFLAGS` or `RUSTDOCFLAGS` Extra command-line flags to pass to `rustdoc`. The value may be a array of strings or a space-separated string. @@ -407,8 +408,9 @@ strings or a space-separated string. There are two mutually exclusive sources of extra flags. They are checked in order, with the first one being used: -1. `RUSTDOCFLAGS` environment variable. -2. `build.rustdocflags` config value. +1. `CARGO_ENCODED_RUSTDOCFLAGS` environment variable. +2. `RUSTDOCFLAGS` environment variable. +3. `build.rustdocflags` config value. Additional flags may also be passed with the [`cargo rustdoc`] command. diff --git a/src/doc/src/reference/environment-variables.md b/src/doc/src/reference/environment-variables.md index 34acf8190bb..893de7aacf2 100644 --- a/src/doc/src/reference/environment-variables.md +++ b/src/doc/src/reference/environment-variables.md @@ -36,16 +36,18 @@ system: invocations that Cargo performs. In contrast with [`cargo rustdoc`], this is useful for passing a flag to *all* `rustdoc` instances. See [`build.rustdocflags`] for some more ways to set flags. This string is - split by whitespace; for a more robust encoding of multiple arguments, - set `CARGO_ENCODED_RUSTDOCFLAGS` instead with arguments separated by - `0x1f` (ASCII Unit Separator). + split by whitespace; for a more robust encoding of multiple arguments, + see `CARGO_ENCODED_RUSTDOCFLAGS`. +* `CARGO_ENCODED_RUSTDOCFLAGS` - A list of custom flags separated by `0x1f` + (ASCII Unit Separator) to pass to all `rustdoc` invocations that Cargo performs. * `RUSTFLAGS` — A space-separated list of custom flags to pass to all compiler invocations that Cargo performs. In contrast with [`cargo rustc`], this is useful for passing a flag to *all* compiler instances. See [`build.rustflags`] for some more ways to set flags. This string is - split by whitespace; for a more robust encoding of multiple arguments, - set `CARGO_ENCODED_RUSTFLAGS` instead with arguments separated by - `0x1f` (ASCII Unit Separator). + split by whitespace; for a more robust encoding of multiple arguments, + see `CARGO_ENCODED_RUSTFLAGS`. +* `CARGO_ENCODED_RUSTFLAGS` - A list of custom flags separated by `0x1f` + (ASCII Unit Separator) to pass to all compiler invocations that Cargo performs. * `CARGO_INCREMENTAL` — If this is set to 1 then Cargo will force [incremental compilation] to be enabled for the current compilation, and when set to 0 it will force disabling it. If this env var isn't present then cargo's defaults