Skip to content

Commit 6878c43

Browse files
borsbors
committed
Auto merge of #10566 - Urgau:check-cfg-improvements, r=ehuss
Improve support of condition compilation checking This PR is a series of improvements to the check-cfg implementation. ### What does this PR try to resolve? This PR resolve the concern expressed in #10486 (comment) that is: * Fixing the tests on Windows: e8aa51d * Merging all the -Z flags under -Zcheck-cfg: 969e282 * Moving of all of the check-cfg tests into a separate module: c18b442 * And removing of an unused parameter: 068bdf4 ### How should we test and review this PR? This PR should be reviewed commit by commit and tested with the automated tests or examples. ### Additional information I decided to use a custom macro to make the test functional under Windows, the macro generate a contains line with the correct escaping depending on the platform (windows or not windows).
2 parents 08b8fe5 + 6f2fae1 commit 6878c43

File tree

10 files changed

+530
-626
lines changed

10 files changed

+530
-626
lines changed

‎src/cargo/core/compiler/context/mod.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -224,7 +224,7 @@ impl<'a, 'cfg> Context<'a, 'cfg> {
224224
let mut unstable_opts = false;
225225
let mut args = compiler::extern_args(&self, unit, &mut unstable_opts)?;
226226
args.extend(compiler::lto_args(&self, unit));
227-
args.extend(compiler::features_args(&self, unit));
227+
args.extend(compiler::features_args(unit));
228228
args.extend(compiler::check_cfg_args(&self, unit));
229229

230230
let script_meta = self.find_build_script_metadata(unit);

‎src/cargo/core/compiler/mod.rs

+32-33
Original file line numberDiff line numberDiff line change
@@ -645,7 +645,7 @@ fn rustdoc(cx: &mut Context<'_, '_>, unit: &Unit) -> CargoResult<Work> {
645645
paths::create_dir_all(&doc_dir)?;
646646

647647
rustdoc.arg("-o").arg(&doc_dir);
648-
rustdoc.args(&features_args(cx, unit));
648+
rustdoc.args(&features_args(unit));
649649
rustdoc.args(&check_cfg_args(cx, unit));
650650

651651
add_error_format_and_color(cx, &mut rustdoc);
@@ -966,7 +966,7 @@ fn build_base_args(
966966
cmd.arg("--cfg").arg("test");
967967
}
968968

969-
cmd.args(&features_args(cx, unit));
969+
cmd.args(&features_args(unit));
970970
cmd.args(&check_cfg_args(cx, unit));
971971

972972
let meta = cx.files().metadata(unit);
@@ -1042,7 +1042,7 @@ fn build_base_args(
10421042
}
10431043

10441044
/// All active features for the unit passed as --cfg
1045-
fn features_args(_cx: &Context<'_, '_>, unit: &Unit) -> Vec<OsString> {
1045+
fn features_args(unit: &Unit) -> Vec<OsString> {
10461046
let mut args = Vec::with_capacity(unit.features.len() * 2);
10471047

10481048
for feat in &unit.features {
@@ -1055,43 +1055,42 @@ fn features_args(_cx: &Context<'_, '_>, unit: &Unit) -> Vec<OsString> {
10551055

10561056
/// Generate the --check-cfg arguments for the unit
10571057
fn check_cfg_args(cx: &Context<'_, '_>, unit: &Unit) -> Vec<OsString> {
1058-
if !cx.bcx.config.cli_unstable().check_cfg_features
1059-
&& !cx.bcx.config.cli_unstable().check_cfg_well_known_names
1060-
&& !cx.bcx.config.cli_unstable().check_cfg_well_known_values
1058+
if let Some((features, well_known_names, well_known_values)) =
1059+
cx.bcx.config.cli_unstable().check_cfg
10611060
{
1062-
return Vec::new();
1063-
}
1064-
1065-
let mut args = Vec::with_capacity(unit.pkg.summary().features().len() * 2 + 4);
1066-
args.push(OsString::from("-Zunstable-options"));
1061+
let mut args = Vec::with_capacity(unit.pkg.summary().features().len() * 2 + 4);
1062+
args.push(OsString::from("-Zunstable-options"));
1063+
1064+
if features {
1065+
// This generate something like this:
1066+
// - values(feature)
1067+
// - values(feature, "foo", "bar")
1068+
let mut arg = OsString::from("values(feature");
1069+
for (&feat, _) in unit.pkg.summary().features() {
1070+
arg.push(", \"");
1071+
arg.push(&feat);
1072+
arg.push("\"");
1073+
}
1074+
arg.push(")");
10671075

1068-
if cx.bcx.config.cli_unstable().check_cfg_features {
1069-
// This generate something like this:
1070-
// - values(feature)
1071-
// - values(feature, "foo", "bar")
1072-
let mut arg = OsString::from("values(feature");
1073-
for (&feat, _) in unit.pkg.summary().features() {
1074-
arg.push(", \"");
1075-
arg.push(&feat);
1076-
arg.push("\"");
1076+
args.push(OsString::from("--check-cfg"));
1077+
args.push(arg);
10771078
}
1078-
arg.push(")");
10791079

1080-
args.push(OsString::from("--check-cfg"));
1081-
args.push(arg);
1082-
}
1080+
if well_known_names {
1081+
args.push(OsString::from("--check-cfg"));
1082+
args.push(OsString::from("names()"));
1083+
}
10831084

1084-
if cx.bcx.config.cli_unstable().check_cfg_well_known_names {
1085-
args.push(OsString::from("--check-cfg"));
1086-
args.push(OsString::from("names()"));
1087-
}
1085+
if well_known_values {
1086+
args.push(OsString::from("--check-cfg"));
1087+
args.push(OsString::from("values()"));
1088+
}
10881089

1089-
if cx.bcx.config.cli_unstable().check_cfg_well_known_values {
1090-
args.push(OsString::from("--check-cfg"));
1091-
args.push(OsString::from("values()"));
1090+
args
1091+
} else {
1092+
Vec::new()
10921093
}
1093-
1094-
args
10951094
}
10961095

10971096
fn lto_args(cx: &Context<'_, '_>, unit: &Unit) -> Vec<OsString> {

‎src/cargo/core/features.rs

+23-6
Original file line numberDiff line numberDiff line change
@@ -641,9 +641,7 @@ unstable_cli_options!(
641641
build_std_features: Option<Vec<String>> = ("Configure features enabled for the standard library itself when building the standard library"),
642642
config_include: bool = ("Enable the `include` key in config files"),
643643
credential_process: bool = ("Add a config setting to fetch registry authentication tokens by calling an external process"),
644-
check_cfg_features: bool = ("Enable compile-time checking of features in `cfg`"),
645-
check_cfg_well_known_names: bool = ("Enable compile-time checking of well known names in `cfg`"),
646-
check_cfg_well_known_values: bool = ("Enable compile-time checking of well known values in `cfg`"),
644+
check_cfg: Option<(/*features:*/ bool, /*well_known_names:*/ bool, /*well_known_values:*/ bool)> = ("Specify scope of compile-time checking of `cfg` names/values"),
647645
doctest_in_workspace: bool = ("Compile doctests with paths relative to the workspace root"),
648646
doctest_xcompile: bool = ("Compile and run doctests for non-host target using runner config"),
649647
dual_proc_macros: bool = ("Build proc-macros for both the host and the target"),
@@ -785,6 +783,27 @@ impl CliUnstable {
785783
}
786784
}
787785

786+
fn parse_check_cfg(value: Option<&str>) -> CargoResult<Option<(bool, bool, bool)>> {
787+
if let Some(value) = value {
788+
let mut features = false;
789+
let mut well_known_names = false;
790+
let mut well_known_values = false;
791+
792+
for e in value.split(',') {
793+
match e {
794+
"features" => features = true,
795+
"names" => well_known_names = true,
796+
"values" => well_known_values = true,
797+
_ => bail!("flag -Zcheck-cfg only takes `features`, `names` or `values` as valid inputs"),
798+
}
799+
}
800+
801+
Ok(Some((features, well_known_names, well_known_values)))
802+
} else {
803+
Ok(None)
804+
}
805+
}
806+
788807
// Asserts that there is no argument to the flag.
789808
fn parse_empty(key: &str, value: Option<&str>) -> CargoResult<bool> {
790809
if let Some(v) = value {
@@ -842,9 +861,7 @@ impl CliUnstable {
842861
"minimal-versions" => self.minimal_versions = parse_empty(k, v)?,
843862
"advanced-env" => self.advanced_env = parse_empty(k, v)?,
844863
"config-include" => self.config_include = parse_empty(k, v)?,
845-
"check-cfg-features" => self.check_cfg_features = parse_empty(k, v)?,
846-
"check-cfg-well-known-names" => self.check_cfg_well_known_names = parse_empty(k, v)?,
847-
"check-cfg-well-known-values" => self.check_cfg_well_known_values = parse_empty(k, v)?,
864+
"check-cfg" => self.check_cfg = parse_check_cfg(v)?,
848865
"dual-proc-macros" => self.dual_proc_macros = parse_empty(k, v)?,
849866
// can also be set in .cargo/config or with and ENV
850867
"mtime-on-use" => self.mtime_on_use = parse_empty(k, v)?,

‎src/doc/src/reference/unstable.md

+13-30
Original file line numberDiff line numberDiff line change
@@ -1188,44 +1188,27 @@ For instance:
11881188
cargo doc -Z unstable-options -Z rustdoc-scrape-examples=examples
11891189
```
11901190

1191-
### check-cfg-features
1191+
### check-cfg
11921192

11931193
* RFC: [#3013](https://github.com/rust-lang/rfcs/pull/3013)
1194+
* Tracking Issue: [#10554](https://github.com/rust-lang/cargo/issues/10554)
11941195

1195-
The `-Z check-cfg-features` argument tells Cargo to pass all possible features of a package to
1196-
`rustc` and `rustdoc` unstable `--check-cfg` command line as `--check-cfg=values(feature, ...)`.
1197-
This enables compile time checking of feature values in `#[cfg]`, `cfg!` and `#[cfg_attr]`.
1198-
Note than this command line options will probably become the default when stabilizing.
1199-
For instance:
1200-
1201-
```
1202-
cargo check -Z unstable-options -Z check-cfg-features
1203-
```
1204-
1205-
### check-cfg-well-known-names
1206-
1207-
* RFC: [#3013](https://github.com/rust-lang/rfcs/pull/3013)
1196+
`-Z check-cfg` command line enables compile time checking of name and values in `#[cfg]`, `cfg!`,
1197+
`#[link]` and `#[cfg_attr]` with the `rustc` and `rustdoc` unstable `--check-cfg` command line.
12081198

1209-
The `-Z check-cfg-well-known-names` argument tells Cargo to activate `rustc` and `rustdoc` unstable
1210-
`--check-cfg` command line as `--check-cfg=names()`.
1211-
This enables compile time checking of well known names in `#[cfg]`, `cfg!` and `#[cfg_attr]`.
1212-
For instance:
1213-
1214-
```
1215-
cargo check -Z unstable-options -Z check-cfg-well-known-names
1216-
```
1217-
1218-
### check-cfg-well-known-values
1219-
1220-
* RFC: [#3013](https://github.com/rust-lang/rfcs/pull/3013)
1199+
It's values are:
1200+
- `features`: enables features checking via `--check-cfg=values(feature, ...)`.
1201+
Note than this command line options will probably become the default when stabilizing.
1202+
- `names`: enables well known names checking via `--check-cfg=names()`.
1203+
- `values`: enables well known values checking via `--check-cfg=values()`.
12211204

1222-
The `-Z check-cfg-well-known-values` argument tells Cargo to activate `rustc` and `rustdoc` unstable
1223-
`--check-cfg` command line as `--check-cfg=values()`.
1224-
This enables compile time checking of well known values in `#[cfg]`, `cfg!` and `#[cfg_attr]`.
12251205
For instance:
12261206

12271207
```
1228-
cargo check -Z unstable-options -Z check-cfg-well-known-values
1208+
cargo check -Z unstable-options -Z check-cfg=features
1209+
cargo check -Z unstable-options -Z check-cfg=names
1210+
cargo check -Z unstable-options -Z check-cfg=values
1211+
cargo check -Z unstable-options -Z check-cfg=features,names,values
12291212
```
12301213

12311214
### workspace-inheritance

0 commit comments

Comments
 (0)