Skip to content

Commit 2e73d67

Browse files
committed
Adjust documentation for newly stabilized -Zcheck-cfg
1 parent 22967ec commit 2e73d67

File tree

2 files changed

+52
-40
lines changed

2 files changed

+52
-40
lines changed

src/doc/src/reference/build-scripts.md

+44-1
Original file line numberDiff line numberDiff line change
@@ -130,6 +130,8 @@ one detailed below.
130130
compiler.
131131
* [`cargo::rustc-cfg=KEY[="VALUE"]`](#rustc-cfg) --- Enables compile-time `cfg`
132132
settings.
133+
* [`cargo::rustc-check-cfg=CHECK_CFG`](#rustc-check-cfg) -- Enables compile-time
134+
checking of configs.
133135
* [`cargo::rustc-env=VAR=VALUE`](#rustc-env) --- Sets an environment variable.
134136
* [`cargo::rustc-cdylib-link-arg=FLAG`](#rustc-cdylib-link-arg) --- Passes custom
135137
flags to a linker for cdylib crates.
@@ -233,7 +235,9 @@ equivalent to using [`rustc-link-lib`](#rustc-link-lib) and
233235

234236
The `rustc-cfg` instruction tells Cargo to pass the given value to the
235237
[`--cfg` flag][option-cfg] to the compiler. This may be used for compile-time
236-
detection of features to enable [conditional compilation].
238+
detection of features to enable [conditional compilation]. Each custom cfgs
239+
must **always** be declared using the [`cargo::rustc-check-cfg`](#rustc-check-cfg)
240+
instruction.
237241

238242
Note that this does *not* affect Cargo's dependency resolution. This cannot be
239243
used to enable an optional dependency, or enable other Cargo features.
@@ -250,6 +254,45 @@ identifier, the value should be a string.
250254
[conditional compilation]: ../../reference/conditional-compilation.md
251255
[option-cfg]: ../../rustc/command-line-arguments.md#option-cfg
252256

257+
### `cargo::rustc-check-cfg=CHECK_CFG` {#rustc-check-cfg}
258+
259+
The `rustc-check-cfg` instruction tells Cargo to pass the given expected
260+
configs to the [`--check-cfg` flag][option-check-cfg] to the compiler. This is
261+
used for compile-time detection of unexpected [conditional compilation] configs.
262+
263+
You can use the instruction like this:
264+
265+
```rust,no_run
266+
// build.rs
267+
println!("cargo::rustc-check-cfg=cfg(foo, values(\"bar\"))");
268+
```
269+
270+
Note that all possible cfgs should be defined, regardless of which cfgs are
271+
currently enabled. This includes all possible values of a given cfg name.
272+
273+
It is recommended to group the `cargo::rustc-check-cfg` and
274+
[`cargo::rustc-cfg`][option-cfg] instructions as closely as possible in order to
275+
avoid typos, missing check-cfg, stalled cfgs...
276+
277+
<details>
278+
<summary>
279+
280+
Example of using `cargo::rustc-check-cfg` and `cargo::rustc-cfg` together
281+
282+
</summary>
283+
284+
```rust,no_run
285+
// build.rs
286+
println!("cargo::rustc-check-cfg=cfg(foo, values(\"bar\"))");
287+
if foo_bar_condition {
288+
println!("cargo::rustc-cfg=foo=\"bar\"");
289+
}
290+
```
291+
292+
</details>
293+
294+
[option-cfg]: ../../rustc/command-line-arguments.md#option-check-cfg
295+
253296
### `cargo::rustc-env=VAR=VALUE` {#rustc-env}
254297

255298
The `rustc-env` instruction tells Cargo to set the given environment variable

src/doc/src/reference/unstable.md

+8-39
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,6 @@ For the latest nightly, see the [nightly version] of this page.
8383
* [build-std-features](#build-std-features) --- Sets features to use with the standard library.
8484
* [binary-dep-depinfo](#binary-dep-depinfo) --- Causes the dep-info file to track binary dependencies.
8585
* [panic-abort-tests](#panic-abort-tests) --- Allows running tests with the "abort" panic strategy.
86-
* [check-cfg](#check-cfg) --- Compile-time validation of `cfg` expressions.
8786
* [host-config](#host-config) --- Allows setting `[target]`-like configuration settings for host build targets.
8887
* [target-applies-to-host](#target-applies-to-host) --- Alters whether certain flags will be passed to host build targets.
8988
* [gc](#gc) --- Global cache garbage collection.
@@ -1141,44 +1140,6 @@ You can use the flag like this:
11411140
cargo rustdoc -Z unstable-options --output-format json
11421141
```
11431142

1144-
## check-cfg
1145-
1146-
* RFC: [#3013](https://github.com/rust-lang/rfcs/pull/3013)
1147-
* Tracking Issue: [#10554](https://github.com/rust-lang/cargo/issues/10554)
1148-
1149-
`-Z check-cfg` command line enables compile time checking of Cargo features as well as `rustc`
1150-
well known names and values in `#[cfg]`, `cfg!`, `#[link]` and `#[cfg_attr]` with the `rustc`
1151-
and `rustdoc` unstable `--check-cfg` command line.
1152-
1153-
You can use the flag like this:
1154-
1155-
```
1156-
cargo check -Z unstable-options -Z check-cfg
1157-
```
1158-
1159-
### `cargo::rustc-check-cfg=CHECK_CFG`
1160-
1161-
The `rustc-check-cfg` instruction tells Cargo to pass the given value to the
1162-
`--check-cfg` flag to the compiler. This may be used for compile-time
1163-
detection of unexpected conditional compilation name and/or values.
1164-
1165-
This can only be used in combination with `-Zcheck-cfg` otherwise it is ignored
1166-
with a warning.
1167-
1168-
If you want to integrate with Cargo features, only use `-Zcheck-cfg` instead of
1169-
trying to do it manually with this option.
1170-
1171-
You can use the instruction like this:
1172-
1173-
```rust,no_run
1174-
// build.rs
1175-
println!("cargo::rustc-check-cfg=cfg(foo, bar)");
1176-
```
1177-
1178-
```
1179-
cargo check -Z unstable-options -Z check-cfg
1180-
```
1181-
11821143
## codegen-backend
11831144

11841145
The `codegen-backend` feature makes it possible to select the codegen backend used by rustc using a profile.
@@ -1785,3 +1746,11 @@ The `-Z registry-auth` feature has been stabilized in the 1.74 release with the
17851746
requirement that a credential-provider is configured.
17861747

17871748
See [Registry Authentication](registry-authentication.md) documentation for details.
1749+
1750+
## check-cfg
1751+
1752+
The `-Z check-cfg` feature has been stabilized in the CURRENT_CARGO_RELEASE release by
1753+
making it the default behavior.
1754+
1755+
See the [build script documentation](build-scripts.md#rustc-check-cfg) for informations
1756+
about specifying custom cfgs.

0 commit comments

Comments
 (0)