Stabilize checking of cfgs at compile-time: --check-cfg option

rust-lang · bors · Apr 16, 2024 · Feb 25, 2024 · Feb 25, 2024 · Apr 15, 2024
commit 909fcfcb6a01b9a811835ba001954e6c62b2a2bc
diff --git a/compiler/rustc_session/src/config.rs b/compiler/rustc_session/src/config.rs
@@ -1373,7 +1373,7 @@ pub fn rustc_short_optgroups() -> Vec<RustcOptGroup> {
  opt::flag_s("h", "help", "Display this message"),
  opt::multi_s("", "cfg", "Configure the compilation environment.
  SPEC supports the syntax `NAME[=\"VALUE\"]`.", "SPEC"),
- opt::multi("", "check-cfg", "Provide list of valid cfg options for checking", "SPEC"),
+ opt::multi_s("", "check-cfg", "Provide list of expected cfgs for checking", "SPEC"),
  opt::multi_s(
  "L",
  "",

diff --git a/src/librustdoc/doctest.rs b/src/librustdoc/doctest.rs
@@ -60,11 +60,8 @@ pub(crate) fn generate_args_file(file_path: &Path, options: &RustdocOptions) ->
  for cfg in &options.cfgs {
  content.push(format!("--cfg={cfg}"));
  }
- if !options.check_cfgs.is_empty() {
- content.push("-Zunstable-options".to_string());
- for check_cfg in &options.check_cfgs {
- content.push(format!("--check-cfg={check_cfg}"));
- }
+ for check_cfg in &options.check_cfgs {
+ content.push(format!("--check-cfg={check_cfg}"));
  }
 
  for lib_str in &options.lib_strs {

diff --git a/src/librustdoc/lib.rs b/src/librustdoc/lib.rs
@@ -242,7 +242,7 @@ fn opts() -> Vec<RustcOptGroup> {
  o.optmulti("L", "library-path", "directory to add to crate search path", "DIR")
  }),
  stable("cfg", |o| o.optmulti("", "cfg", "pass a --cfg to rustc", "")),
- unstable("check-cfg", |o| o.optmulti("", "check-cfg", "pass a --check-cfg to rustc", "")),
+ stable("check-cfg", |o| o.optmulti("", "check-cfg", "pass a --check-cfg to rustc", "")),
  stable("extern", |o| o.optmulti("", "extern", "pass an --extern to rustc", "NAME[=PATH]")),
  unstable("extern-html-root-url", |o| {
  o.optmulti(

diff --git a/tests/rustdoc-ui/check-cfg/check-cfg.rs → tests/rustdoc-ui/check-cfg.rs b/tests/rustdoc-ui/check-cfg/check-cfg.rs → tests/rustdoc-ui/check-cfg.rs
@@ -1,5 +1,5 @@
 //@ check-pass
-//@ compile-flags: --check-cfg=cfg() -Z unstable-options
+//@ compile-flags: --check-cfg=cfg()
 
 /// uniz is nor a builtin nor pass as arguments so is unexpected
 #[cfg(uniz)]

diff --git a/tests/rustdoc-ui/check-cfg/check-cfg.stderr → tests/rustdoc-ui/check-cfg.stderr b/tests/rustdoc-ui/check-cfg/check-cfg.stderr → tests/rustdoc-ui/check-cfg.stderr
diff --git a/tests/rustdoc-ui/check-cfg/check-cfg-test.stderr b/tests/rustdoc-ui/check-cfg/check-cfg-test.stderr
diff --git a/tests/rustdoc-ui/check-cfg/check-cfg-unstable.rs b/tests/rustdoc-ui/check-cfg/check-cfg-unstable.rs
diff --git a/tests/rustdoc-ui/check-cfg/check-cfg-unstable.stderr b/tests/rustdoc-ui/check-cfg/check-cfg-unstable.stderr
diff --git a/tests/ui/check-cfg/allow-at-crate-level.rs b/tests/ui/check-cfg/allow-at-crate-level.rs
@@ -1,7 +1,7 @@
 // This test check that #![allow(unexpected_cfgs)] works with --cfg
 //
 //@ check-pass
-//@ compile-flags: --cfg=unexpected --check-cfg=cfg() -Z unstable-options
+//@ compile-flags: --cfg=unexpected --check-cfg=cfg()
 
 #![allow(unexpected_cfgs)]
 

diff --git a/tests/ui/check-cfg/allow-macro-cfg.rs b/tests/ui/check-cfg/allow-macro-cfg.rs
@@ -1,7 +1,7 @@
 // This test check that local #[allow(unexpected_cfgs)] works
 //
 //@ check-pass
-//@ compile-flags: --check-cfg=cfg() -Z unstable-options
+//@ compile-flags: --check-cfg=cfg()
 
 #[allow(unexpected_cfgs)]
 fn foo() {

diff --git a/tests/ui/check-cfg/allow-same-level.rs b/tests/ui/check-cfg/allow-same-level.rs
@@ -1,7 +1,7 @@
 // This test check that #[allow(unexpected_cfgs)] doesn't work if put on the same level
 //
 //@ check-pass
-//@ compile-flags: --check-cfg=cfg() -Z unstable-options
+//@ compile-flags: --check-cfg=cfg()
 
 #[allow(unexpected_cfgs)]
 #[cfg(FALSE)]

diff --git a/tests/ui/check-cfg/allow-top-level.rs b/tests/ui/check-cfg/allow-top-level.rs
@@ -1,7 +1,7 @@
 // This test check that a top-level #![allow(unexpected_cfgs)] works
 //
 //@ check-pass
-//@ compile-flags: --check-cfg=cfg() -Z unstable-options
+//@ compile-flags: --check-cfg=cfg()
 
 #![allow(unexpected_cfgs)]
 

diff --git a/tests/ui/check-cfg/allow-upper-level.rs b/tests/ui/check-cfg/allow-upper-level.rs
@@ -1,7 +1,7 @@
 // This test check that #[allow(unexpected_cfgs)] work if put on an upper level
 //
 //@ check-pass
-//@ compile-flags: --check-cfg=cfg() -Z unstable-options
+//@ compile-flags: --check-cfg=cfg()
 
 #[allow(unexpected_cfgs)]
 mod aa {

diff --git a/tests/ui/check-cfg/cargo-feature.none.stderr b/tests/ui/check-cfg/cargo-feature.none.stderr
@@ -1,5 +1,5 @@
 warning: unexpected `cfg` condition value: `serde`
- --> $DIR/cargo-feature.rs:14:7
+ --> $DIR/cargo-feature.rs:13:7
  |
 LL | #[cfg(feature = "serde")]
  | ^^^^^^^^^^^^^^^^^ help: remove the condition
@@ -10,7 +10,7 @@ LL | #[cfg(feature = "serde")]
  = note: `#[warn(unexpected_cfgs)]` on by default
 
 warning: unexpected `cfg` condition value: (none)
- --> $DIR/cargo-feature.rs:18:7
+ --> $DIR/cargo-feature.rs:17:7
  |
 LL | #[cfg(feature)]
  | ^^^^^^^ help: remove the condition
@@ -20,7 +20,7 @@ LL | #[cfg(feature)]
  = note: see <https://doc.rust-lang.org/nightly/cargo/reference/unstable.html#check-cfg> for more information about checking conditional configuration
 
 warning: unexpected `cfg` condition name: `tokio_unstable`
- --> $DIR/cargo-feature.rs:22:7
+ --> $DIR/cargo-feature.rs:21:7
  |
 LL | #[cfg(tokio_unstable)]
  | ^^^^^^^^^^^^^^
@@ -30,7 +30,7 @@ LL | #[cfg(tokio_unstable)]
  = note: see <https://doc.rust-lang.org/nightly/cargo/reference/unstable.html#check-cfg> for more information about checking conditional configuration
 
 warning: unexpected `cfg` condition name: `CONFIG_NVME`
- --> $DIR/cargo-feature.rs:26:7
+ --> $DIR/cargo-feature.rs:25:7
  |
 LL | #[cfg(CONFIG_NVME = "m")]
  | ^^^^^^^^^^^^^^^^^

diff --git a/tests/ui/check-cfg/cargo-feature.rs b/tests/ui/check-cfg/cargo-feature.rs
@@ -5,7 +5,6 @@
 //@ check-pass
 //@ revisions: some none
 //@ rustc-env:CARGO_CRATE_NAME=foo
-//@ compile-flags: -Z unstable-options
 //@ [none]compile-flags: --check-cfg=cfg(feature,values())
 //@ [some]compile-flags: --check-cfg=cfg(feature,values("bitcode"))
 //@ [some]compile-flags: --check-cfg=cfg(CONFIG_NVME,values("y"))

diff --git a/tests/ui/check-cfg/cargo-feature.some.stderr b/tests/ui/check-cfg/cargo-feature.some.stderr
@@ -1,5 +1,5 @@
 warning: unexpected `cfg` condition value: `serde`
- --> $DIR/cargo-feature.rs:14:7
+ --> $DIR/cargo-feature.rs:13:7
  |
 LL | #[cfg(feature = "serde")]
  | ^^^^^^^^^^^^^^^^^
@@ -10,7 +10,7 @@ LL | #[cfg(feature = "serde")]
  = note: `#[warn(unexpected_cfgs)]` on by default
 
 warning: unexpected `cfg` condition value: (none)
- --> $DIR/cargo-feature.rs:18:7
+ --> $DIR/cargo-feature.rs:17:7
  |
 LL | #[cfg(feature)]
  | ^^^^^^^- help: specify a config value: `= "bitcode"`
@@ -20,7 +20,7 @@ LL | #[cfg(feature)]
  = note: see <https://doc.rust-lang.org/nightly/cargo/reference/unstable.html#check-cfg> for more information about checking conditional configuration
 
 warning: unexpected `cfg` condition name: `tokio_unstable`
- --> $DIR/cargo-feature.rs:22:7
+ --> $DIR/cargo-feature.rs:21:7
  |
 LL | #[cfg(tokio_unstable)]
  | ^^^^^^^^^^^^^^
@@ -30,7 +30,7 @@ LL | #[cfg(tokio_unstable)]
  = note: see <https://doc.rust-lang.org/nightly/cargo/reference/unstable.html#check-cfg> for more information about checking conditional configuration
 
 warning: unexpected `cfg` condition value: `m`
- --> $DIR/cargo-feature.rs:26:7
+ --> $DIR/cargo-feature.rs:25:7
  |
 LL | #[cfg(CONFIG_NVME = "m")]
  | ^^^^^^^^^^^^^^---

diff --git a/tests/ui/check-cfg/cfg-value-for-cfg-name-duplicate.rs b/tests/ui/check-cfg/cfg-value-for-cfg-name-duplicate.rs
@@ -2,7 +2,6 @@
 // This test checks we won't suggest more than 3 span suggestions for cfg names
 //
 //@ check-pass
-//@ compile-flags: -Z unstable-options
 //@ compile-flags: --check-cfg=cfg(foo,values("value")) --check-cfg=cfg(bar,values("value")) --check-cfg=cfg(bee,values("value")) --check-cfg=cfg(cow,values("value"))
 
 #[cfg(value)]

diff --git a/tests/ui/check-cfg/cfg-value-for-cfg-name-duplicate.stderr b/tests/ui/check-cfg/cfg-value-for-cfg-name-duplicate.stderr
@@ -1,5 +1,5 @@
 warning: unexpected `cfg` condition name: `value`
- --> $DIR/cfg-value-for-cfg-name-duplicate.rs:8:7
+ --> $DIR/cfg-value-for-cfg-name-duplicate.rs:7:7
  |
 LL | #[cfg(value)]
  | ^^^^^

diff --git a/tests/ui/check-cfg/cfg-value-for-cfg-name-multiple.rs b/tests/ui/check-cfg/cfg-value-for-cfg-name-multiple.rs
@@ -2,7 +2,6 @@
 // This test checks that when a single cfg has a value for user's specified name
 //
 //@ check-pass
-//@ compile-flags: -Z unstable-options
 //@ compile-flags: --check-cfg=cfg(foo,values("my_value")) --check-cfg=cfg(bar,values("my_value"))
 
 #[cfg(my_value)]

diff --git a/tests/ui/check-cfg/cfg-value-for-cfg-name-multiple.stderr b/tests/ui/check-cfg/cfg-value-for-cfg-name-multiple.stderr
@@ -1,5 +1,5 @@
 warning: unexpected `cfg` condition name: `my_value`
- --> $DIR/cfg-value-for-cfg-name-multiple.rs:8:7
+ --> $DIR/cfg-value-for-cfg-name-multiple.rs:7:7
  |
 LL | #[cfg(my_value)]
  | ^^^^^^^^

diff --git a/tests/ui/check-cfg/cfg-value-for-cfg-name.rs b/tests/ui/check-cfg/cfg-value-for-cfg-name.rs
@@ -3,7 +3,6 @@
 // suggest to use `#[cfg(target_os = "linux")]` instead of `#[cfg(linux)]`
 //
 //@ check-pass
-//@ compile-flags: -Z unstable-options
 //@ compile-flags: --check-cfg=cfg()
 
 #[cfg(linux)]

diff --git a/tests/ui/check-cfg/cfg-value-for-cfg-name.stderr b/tests/ui/check-cfg/cfg-value-for-cfg-name.stderr
@@ -1,5 +1,5 @@
 warning: unexpected `cfg` condition name: `linux`
- --> $DIR/cfg-value-for-cfg-name.rs:9:7
+ --> $DIR/cfg-value-for-cfg-name.rs:8:7
  |
 LL | #[cfg(linux)]
  | ^^^^^ help: found config with similar value: `target_os = "linux"`
@@ -10,7 +10,7 @@ LL | #[cfg(linux)]
  = note: `#[warn(unexpected_cfgs)]` on by default
 
 warning: unexpected `cfg` condition name: `linux`
- --> $DIR/cfg-value-for-cfg-name.rs:14:7
+ --> $DIR/cfg-value-for-cfg-name.rs:13:7
  |
 LL | #[cfg(linux = "os-name")]
  | ^^^^^^^^^^^^^^^^^

diff --git a/tests/ui/check-cfg/compact-names.rs b/tests/ui/check-cfg/compact-names.rs
@@ -1,7 +1,7 @@
 // This test check that we correctly emit an warning for compact cfg
 //
 //@ check-pass
-//@ compile-flags: --check-cfg=cfg() -Z unstable-options
+//@ compile-flags: --check-cfg=cfg()
 
 #![feature(cfg_target_compact)]
 

diff --git a/tests/ui/check-cfg/compact-values.rs b/tests/ui/check-cfg/compact-values.rs
@@ -1,7 +1,7 @@
 // This test check that we correctly emit an warning for compact cfg
 //
 //@ check-pass
-//@ compile-flags: --check-cfg=cfg() -Z unstable-options
+//@ compile-flags: --check-cfg=cfg()
 
 #![feature(cfg_target_compact)]
 

diff --git a/tests/ui/check-cfg/concat-values.rs b/tests/ui/check-cfg/concat-values.rs
@@ -1,5 +1,4 @@
 //@ check-pass
-//@ compile-flags: -Z unstable-options
 //@ compile-flags: --check-cfg=cfg(my_cfg,values("foo")) --check-cfg=cfg(my_cfg,values("bar"))
 //@ compile-flags: --check-cfg=cfg(my_cfg,values())
 

diff --git a/tests/ui/check-cfg/concat-values.stderr b/tests/ui/check-cfg/concat-values.stderr
@@ -1,5 +1,5 @@
 warning: unexpected `cfg` condition value: (none)
- --> $DIR/concat-values.rs:6:7
+ --> $DIR/concat-values.rs:5:7
  |
 LL | #[cfg(my_cfg)]
  | ^^^^^^
@@ -10,7 +10,7 @@ LL | #[cfg(my_cfg)]
  = note: `#[warn(unexpected_cfgs)]` on by default
 
 warning: unexpected `cfg` condition value: `unk`
- --> $DIR/concat-values.rs:10:7
+ --> $DIR/concat-values.rs:9:7
  |
 LL | #[cfg(my_cfg = "unk")]
  | ^^^^^^^^^^^^^^

diff --git a/tests/ui/check-cfg/diagnotics.rs b/tests/ui/check-cfg/diagnotics.rs
@@ -2,7 +2,7 @@
 //@ revisions: cargo rustc
 //@ [rustc]unset-rustc-env:CARGO_CRATE_NAME
 //@ [cargo]rustc-env:CARGO_CRATE_NAME=foo
-//@ compile-flags: --check-cfg=cfg(feature,values("foo")) --check-cfg=cfg(no_values) -Z unstable-options
+//@ compile-flags: --check-cfg=cfg(feature,values("foo")) --check-cfg=cfg(no_values)
 
 #[cfg(featur)]
 //~^ WARNING unexpected `cfg` condition name

diff --git a/tests/ui/check-cfg/empty-values.rs b/tests/ui/check-cfg/empty-values.rs
@@ -1,7 +1,7 @@
 // Check that we detect unexpected value when none are allowed
 //
 //@ check-pass
-//@ compile-flags: --check-cfg=cfg(foo,values()) -Zunstable-options
+//@ compile-flags: --check-cfg=cfg(foo,values())
 
 #[cfg(foo = "foo")]
 //~^ WARNING unexpected `cfg` condition value

diff --git a/tests/ui/check-cfg/exhaustive-names-values.empty_cfg.stderr b/tests/ui/check-cfg/exhaustive-names-values.empty_cfg.stderr
@@ -1,5 +1,5 @@
 warning: unexpected `cfg` condition name: `unknown_key`
- --> $DIR/exhaustive-names-values.rs:10:7
+ --> $DIR/exhaustive-names-values.rs:9:7
  |
 LL | #[cfg(unknown_key = "value")]
  | ^^^^^^^^^^^^^^^^^^^^^
@@ -10,7 +10,7 @@ LL | #[cfg(unknown_key = "value")]
  = note: `#[warn(unexpected_cfgs)]` on by default
 
 warning: unexpected `cfg` condition value: `value`
- --> $DIR/exhaustive-names-values.rs:14:7
+ --> $DIR/exhaustive-names-values.rs:13:7
  |
 LL | #[cfg(test = "value")]
  | ^^^^----------
@@ -21,7 +21,7 @@ LL | #[cfg(test = "value")]
  = note: see <https://doc.rust-lang.org/nightly/unstable-book/compiler-flags/check-cfg.html> for more information about checking conditional configuration
 
 warning: unexpected `cfg` condition name: `feature`
- --> $DIR/exhaustive-names-values.rs:18:7
+ --> $DIR/exhaustive-names-values.rs:17:7
  |
 LL | #[cfg(feature = "unk")]
  | ^^^^^^^^^^^^^^^
@@ -30,7 +30,7 @@ LL | #[cfg(feature = "unk")]
  = note: see <https://doc.rust-lang.org/nightly/unstable-book/compiler-flags/check-cfg.html> for more information about checking conditional configuration
 
 warning: unexpected `cfg` condition name: `feature`
- --> $DIR/exhaustive-names-values.rs:25:7
+ --> $DIR/exhaustive-names-values.rs:24:7
  |
 LL | #[cfg(feature = "std")]
  | ^^^^^^^^^^^^^^^

diff --git a/tests/ui/check-cfg/exhaustive-names-values.feature.stderr b/tests/ui/check-cfg/exhaustive-names-values.feature.stderr
@@ -1,5 +1,5 @@
 warning: unexpected `cfg` condition name: `unknown_key`
- --> $DIR/exhaustive-names-values.rs:10:7
+ --> $DIR/exhaustive-names-values.rs:9:7
  |
 LL | #[cfg(unknown_key = "value")]
  | ^^^^^^^^^^^^^^^^^^^^^
@@ -10,7 +10,7 @@ LL | #[cfg(unknown_key = "value")]
  = note: `#[warn(unexpected_cfgs)]` on by default
 
 warning: unexpected `cfg` condition value: `value`
- --> $DIR/exhaustive-names-values.rs:14:7
+ --> $DIR/exhaustive-names-values.rs:13:7
  |
 LL | #[cfg(test = "value")]
  | ^^^^----------
@@ -21,7 +21,7 @@ LL | #[cfg(test = "value")]
  = note: see <https://doc.rust-lang.org/nightly/unstable-book/compiler-flags/check-cfg.html> for more information about checking conditional configuration
 
 warning: unexpected `cfg` condition value: `unk`
- --> $DIR/exhaustive-names-values.rs:18:7
+ --> $DIR/exhaustive-names-values.rs:17:7
  |
 LL | #[cfg(feature = "unk")]
  | ^^^^^^^^^^^^^^^

diff --git a/tests/ui/check-cfg/exhaustive-names-values.full.stderr b/tests/ui/check-cfg/exhaustive-names-values.full.stderr
@@ -1,5 +1,5 @@
 warning: unexpected `cfg` condition name: `unknown_key`
- --> $DIR/exhaustive-names-values.rs:10:7
+ --> $DIR/exhaustive-names-values.rs:9:7
  |
 LL | #[cfg(unknown_key = "value")]
  | ^^^^^^^^^^^^^^^^^^^^^
@@ -10,7 +10,7 @@ LL | #[cfg(unknown_key = "value")]
  = note: `#[warn(unexpected_cfgs)]` on by default
 
 warning: unexpected `cfg` condition value: `value`
- --> $DIR/exhaustive-names-values.rs:14:7
+ --> $DIR/exhaustive-names-values.rs:13:7
  |
 LL | #[cfg(test = "value")]
  | ^^^^----------
@@ -21,7 +21,7 @@ LL | #[cfg(test = "value")]
  = note: see <https://doc.rust-lang.org/nightly/unstable-book/compiler-flags/check-cfg.html> for more information about checking conditional configuration
 
 warning: unexpected `cfg` condition value: `unk`
- --> $DIR/exhaustive-names-values.rs:18:7
+ --> $DIR/exhaustive-names-values.rs:17:7
  |
 LL | #[cfg(feature = "unk")]
  | ^^^^^^^^^^^^^^^

diff --git a/tests/ui/check-cfg/exhaustive-names-values.rs b/tests/ui/check-cfg/exhaustive-names-values.rs
@@ -2,7 +2,6 @@
 //
 //@ check-pass
 //@ revisions: empty_cfg feature full
-//@ compile-flags: -Z unstable-options
 //@ [empty_cfg]compile-flags: --check-cfg=cfg()
 //@ [feature]compile-flags: --check-cfg=cfg(feature,values("std"))
 //@ [full]compile-flags: --check-cfg=cfg(feature,values("std")) --check-cfg=cfg()

diff --git a/tests/ui/check-cfg/exhaustive-names.rs b/tests/ui/check-cfg/exhaustive-names.rs
@@ -1,7 +1,7 @@
 // Check warning for unexpected cfg
 //
 //@ check-pass
-//@ compile-flags: --check-cfg=cfg() -Z unstable-options
+//@ compile-flags: --check-cfg=cfg()
 
 #[cfg(unknown_key = "value")]
 //~^ WARNING unexpected `cfg` condition name