@@ -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
234236The ` 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
238242Note that this does * not* affect Cargo's dependency resolution. This cannot be
239243used 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
255298The ` rustc-env ` instruction tells Cargo to set the given environment variable
0 commit comments