Skip to content

Commit f75d4ea

Browse files
borsbors
committed
Auto merge of #10428 - Urgau:check-cfg-features-rustdoc, r=ehuss
Add -Z check-cfg-features support for rustdoc This PR is a follow to #10408 where support for compile-time checking of features was implemented for `rustc`. At the time `rustdoc` support wasn't yet merged, but now that it has been [merged](rust-lang/rust#94154), this pull-request add support for it in the `doc` and `test --doc` (doctest) mode. r? `@alexcrichton`
2 parents 1e55490 + e828e85 commit f75d4ea

File tree

5 files changed

+111
-34
lines changed

5 files changed

+111
-34
lines changed

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

+1-4
Original file line numberDiff line numberDiff line change
@@ -224,11 +224,8 @@ 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));
227228

228-
for feature in &unit.features {
229-
args.push("--cfg".into());
230-
args.push(format!("feature=\"{}\"", feature).into());
231-
}
232229
let script_meta = self.find_build_script_metadata(unit);
233230
if let Some(meta) = script_meta {
234231
if let Some(output) = self.build_script_outputs.lock().unwrap().get(meta) {

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

+31-27
Original file line numberDiff line numberDiff line change
@@ -645,10 +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-
649-
for feat in &unit.features {
650-
rustdoc.arg("--cfg").arg(&format!("feature=\"{}\"", feat));
651-
}
648+
rustdoc.args(&features_args(cx, unit));
652649

653650
add_error_format_and_color(cx, &mut rustdoc);
654651
add_allow_features(cx, &mut rustdoc);
@@ -791,28 +788,6 @@ fn add_allow_features(cx: &Context<'_, '_>, cmd: &mut ProcessBuilder) {
791788
}
792789
}
793790

794-
/// Add all features as cfg
795-
fn add_features(cx: &Context<'_, '_>, cmd: &mut ProcessBuilder, unit: &Unit) {
796-
for feat in &unit.features {
797-
cmd.arg("--cfg").arg(&format!("feature=\"{}\"", feat));
798-
}
799-
800-
if cx.bcx.config.cli_unstable().check_cfg_features {
801-
// This generate something like this:
802-
// - values(feature)
803-
// - values(feature, "foo", "bar")
804-
let mut arg = String::from("values(feature");
805-
for (&feat, _) in unit.pkg.summary().features() {
806-
arg.push_str(", \"");
807-
arg.push_str(&feat);
808-
arg.push_str("\"");
809-
}
810-
arg.push(')');
811-
812-
cmd.arg("-Zunstable-options").arg("--check-cfg").arg(&arg);
813-
}
814-
}
815-
816791
/// Add error-format flags to the command.
817792
///
818793
/// Cargo always uses JSON output. This has several benefits, such as being
@@ -990,7 +965,7 @@ fn build_base_args(
990965
cmd.arg("--cfg").arg("test");
991966
}
992967

993-
add_features(cx, cmd, unit);
968+
cmd.args(&features_args(cx, unit));
994969

995970
let meta = cx.files().metadata(unit);
996971
cmd.arg("-C").arg(&format!("metadata={}", meta));
@@ -1064,6 +1039,35 @@ fn build_base_args(
10641039
Ok(())
10651040
}
10661041

1042+
/// Features with --cfg and all features with --check-cfg
1043+
fn features_args(cx: &Context<'_, '_>, unit: &Unit) -> Vec<OsString> {
1044+
let mut args = Vec::with_capacity(unit.features.len() + 2);
1045+
1046+
for feat in &unit.features {
1047+
args.push(OsString::from("--cfg"));
1048+
args.push(OsString::from(format!("feature=\"{}\"", feat)));
1049+
}
1050+
1051+
if cx.bcx.config.cli_unstable().check_cfg_features {
1052+
// This generate something like this:
1053+
// - values(feature)
1054+
// - values(feature, "foo", "bar")
1055+
let mut arg = OsString::from("values(feature");
1056+
for (&feat, _) in unit.pkg.summary().features() {
1057+
arg.push(", \"");
1058+
arg.push(&feat);
1059+
arg.push("\"");
1060+
}
1061+
arg.push(")");
1062+
1063+
args.push(OsString::from("-Zunstable-options"));
1064+
args.push(OsString::from("--check-cfg"));
1065+
args.push(arg);
1066+
}
1067+
1068+
args
1069+
}
1070+
10671071
fn lto_args(cx: &Context<'_, '_>, unit: &Unit) -> Vec<OsString> {
10681072
let mut result = Vec::new();
10691073
let mut push = |arg: &str| {

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

+3-3
Original file line numberDiff line numberDiff line change
@@ -1132,9 +1132,9 @@ cargo doc -Z unstable-options -Z rustdoc-scrape-examples=examples
11321132
* RFC: [#3013](https://github.com/rust-lang/rfcs/pull/3013)
11331133

11341134
The `-Z check-cfg-features` argument tells Cargo to pass all possible features of a package to
1135-
`rustc` unstable `--check-cfg` command line as `--check-cfg=values(feature, ...)`. This enables
1136-
compile time checking of feature values in `#[cfg]`, `cfg!` and `#[cfg_attr]`. Note than this
1137-
command line options will probably become the default when stabilizing.
1135+
`rustc` and `rustdoc` unstable `--check-cfg` command line as `--check-cfg=values(feature, ...)`.
1136+
This enables compile time checking of feature values in `#[cfg]`, `cfg!` and `#[cfg_attr]`.
1137+
Note than this command line options will probably become the default when stabilizing.
11381138
For instance:
11391139

11401140
```

‎tests/testsuite/doc.rs

+37
Original file line numberDiff line numberDiff line change
@@ -2697,3 +2697,40 @@ fn doc_lib_false_dep() {
26972697
assert!(p.build_dir().join("doc/foo").exists());
26982698
assert!(!p.build_dir().join("doc/bar").exists());
26992699
}
2700+
2701+
#[cfg_attr(windows, ignore)] // weird normalization issue with windows and cargo-test-support
2702+
#[cargo_test]
2703+
fn doc_check_cfg_features() {
2704+
if !is_nightly() {
2705+
// --check-cfg is a nightly only rustdoc command line
2706+
return;
2707+
}
2708+
2709+
let p = project()
2710+
.file(
2711+
"Cargo.toml",
2712+
r#"
2713+
[project]
2714+
name = "foo"
2715+
version = "0.1.0"
2716+
2717+
[features]
2718+
default = ["f_a"]
2719+
f_a = []
2720+
f_b = []
2721+
"#,
2722+
)
2723+
.file("src/lib.rs", "#[allow(dead_code)] fn foo() {}")
2724+
.build();
2725+
2726+
p.cargo("doc -v -Z check-cfg-features")
2727+
.masquerade_as_nightly_cargo()
2728+
.with_stderr(
2729+
"\
2730+
[DOCUMENTING] foo v0.1.0 [..]
2731+
[RUNNING] `rustdoc [..] --check-cfg 'values(feature, \"default\", \"f_a\", \"f_b\")' [..]
2732+
[FINISHED] [..]
2733+
",
2734+
)
2735+
.run();
2736+
}

‎tests/testsuite/test.rs

+39
Original file line numberDiff line numberDiff line change
@@ -4536,3 +4536,42 @@ fn check_cfg_features() {
45364536
)
45374537
.run();
45384538
}
4539+
4540+
#[cfg_attr(windows, ignore)] // weird normalization issue with windows and cargo-test-support
4541+
#[cargo_test]
4542+
fn check_cfg_features_doc() {
4543+
if !is_nightly() {
4544+
// --check-cfg is a nightly only rustc and rustdoc command line
4545+
return;
4546+
}
4547+
4548+
let p = project()
4549+
.file(
4550+
"Cargo.toml",
4551+
r#"
4552+
[project]
4553+
name = "foo"
4554+
version = "0.1.0"
4555+
4556+
[features]
4557+
default = ["f_a"]
4558+
f_a = []
4559+
f_b = []
4560+
"#,
4561+
)
4562+
.file("src/lib.rs", "#[allow(dead_code)] fn foo() {}")
4563+
.build();
4564+
4565+
p.cargo("test -v --doc -Z check-cfg-features")
4566+
.masquerade_as_nightly_cargo()
4567+
.with_stderr(
4568+
"\
4569+
[COMPILING] foo v0.1.0 [..]
4570+
[RUNNING] `rustc [..] --check-cfg 'values(feature, \"default\", \"f_a\", \"f_b\")' [..]
4571+
[FINISHED] test [unoptimized + debuginfo] target(s) in [..]
4572+
[DOCTEST] foo
4573+
[RUNNING] `rustdoc [..] --check-cfg 'values(feature, \"default\", \"f_a\", \"f_b\")' [..]
4574+
",
4575+
)
4576+
.run();
4577+
}

0 commit comments

Comments
 (0)