Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove implicit names and values from --cfg in --check-cfg #99519

Merged
merged 1 commit into from
Aug 1, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion compiler/rustc_interface/src/util.rs
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,6 @@ pub fn create_session(

let mut check_cfg = config::to_crate_check_config(check_cfg);
check_cfg.fill_well_known();
check_cfg.fill_actual(&cfg);

sess.parse_sess.config = cfg;
sess.parse_sess.check_config = check_cfg;
Expand Down
14 changes: 0 additions & 14 deletions compiler/rustc_session/src/config.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1157,20 +1157,6 @@ impl CrateCheckConfig {
self.fill_well_known_names();
self.fill_well_known_values();
}

/// Fills a `CrateCheckConfig` with configuration names and values that are actually active.
pub fn fill_actual(&mut self, cfg: &CrateConfig) {
for &(k, v) in cfg {
if let Some(names_valid) = &mut self.names_valid {
names_valid.insert(k);
}
if let Some(v) = v {
self.values_valid.entry(k).and_modify(|values| {
values.insert(v);
});
}
}
}
}

pub fn build_configuration(sess: &Session, mut user_cfg: CrateConfig) -> CrateConfig {
Expand Down
35 changes: 9 additions & 26 deletions src/doc/unstable-book/src/compiler-flags/check-cfg.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,9 @@ check cfg specification is parsed using the Rust metadata syntax, just as the `-
These two options are independent. `names` checks only the namespace of condition names
while `values` checks only the namespace of the values of list-valued conditions.

NOTE: No implicit expectation is added when using `--cfg` for both forms. Users are expected to
pass all expected names and values using `names(...)` and `values(...)`.

## The `names(...)` form

The `names(...)` form enables checking the names. This form uses a named list:
Expand Down Expand Up @@ -53,27 +56,6 @@ The first form enables checking condition names, while specifying that there are
condition names (outside of the set of well-known names defined by `rustc`). Omitting the
`--check-cfg 'names(...)'` option does not enable checking condition names.

Conditions that are enabled are implicitly valid; it is unnecessary (but legal) to specify a
condition name as both enabled and valid. For example, the following invocations are equivalent:

```bash
# condition names will be checked, and 'has_time_travel' is valid
rustc --cfg 'has_time_travel' --check-cfg 'names()'

# condition names will be checked, and 'has_time_travel' is valid
rustc --cfg 'has_time_travel' --check-cfg 'names(has_time_travel)'
```

In contrast, the following two invocations are _not_ equivalent:

```bash
# condition names will not be checked (because there is no --check-cfg names(...))
rustc --cfg 'has_time_travel'

# condition names will be checked, and 'has_time_travel' is both valid and enabled.
rustc --cfg 'has_time_travel' --check-cfg 'names(has_time_travel)'
```

## The `values(...)` form

The `values(...)` form enables checking the values within list-valued conditions. It has this
Expand Down Expand Up @@ -149,7 +131,7 @@ fn tame_lion() {}
```bash
# This turns on checking for condition names, but not values, such as 'feature' values.
rustc --check-cfg 'names(is_embedded, has_feathers)' \
--cfg has_feathers --cfg 'feature = "zapping"' -Z unstable-options
--cfg has_feathers -Z unstable-options
```

```rust
Expand All @@ -159,13 +141,14 @@ fn do_embedded() {}
#[cfg(has_feathers)] // This is expected as "has_feathers" was provided in names()
fn do_features() {}

#[cfg(has_feathers = "zapping")] // This is expected as "has_feathers" was provided in names()
// and because no value checking was enable for "has_feathers"
// no warning is emited for the value "zapping"
fn do_zapping() {}

#[cfg(has_mumble_frotz)] // This is UNEXPECTED because names checking is enable and
// "has_mumble_frotz" was not provided in names()
fn do_mumble_frotz() {}

#[cfg(feature = "lasers")] // This doesn't raise a warning, because values checking for "feature"
// was never used
fn shoot_lasers() {}
```

### Example: Checking feature values, but not condition names
Expand Down
1 change: 1 addition & 0 deletions src/test/ui/check-cfg/invalid-cfg-value.rs
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ pub fn f() {}
pub fn g() {}

#[cfg(feature = "rand")]
//~^ WARNING unexpected `cfg` condition value
pub fn h() {}

pub fn main() {}
12 changes: 10 additions & 2 deletions src/test/ui/check-cfg/invalid-cfg-value.stderr
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,15 @@ LL | #[cfg(feature = "sedre")]
| ^^^^^^^^^^^^^^^^^
|
= note: `#[warn(unexpected_cfgs)]` on by default
= note: expected values for `feature` are: full, rand, serde
= note: expected values for `feature` are: full, serde

warning: 1 warning emitted
warning: unexpected `cfg` condition value
--> $DIR/invalid-cfg-value.rs:14:7
|
LL | #[cfg(feature = "rand")]
| ^^^^^^^^^^^^^^^^
|
= note: expected values for `feature` are: full, serde

warning: 2 warnings emitted

8 changes: 5 additions & 3 deletions src/test/ui/check-cfg/mix.rs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// This test checks the combination of well known names, their activation via names(), the usage of
// partial values() with a --cfg and test that we also correctly lint on the `cfg!` macro and
// `cfg_attr` attribute.
// This test checks the combination of well known names, their activation via names(),
// the usage of values(), and that no implicit is done with --cfg while also testing that
// we correctly lint on the `cfg!` macro and `cfg_attr` attribute.
//
// check-pass
// compile-flags: --check-cfg=names() --check-cfg=values(feature,"foo") --cfg feature="bar" -Z unstable-options
Expand All @@ -16,6 +16,7 @@ fn do_windows_stuff() {}
fn use_foo() {}

#[cfg(feature = "bar")]
//~^ WARNING unexpected `cfg` condition value
fn use_bar() {}

#[cfg(feature = "zebra")]
Expand All @@ -35,6 +36,7 @@ fn test_cfg_macro() {
//~^ WARNING unexpected `cfg` condition name
cfg!(feature = "foo");
cfg!(feature = "bar");
//~^ WARNING unexpected `cfg` condition value
cfg!(feature = "zebra");
//~^ WARNING unexpected `cfg` condition value
cfg!(xxx = "foo");
Expand Down
80 changes: 47 additions & 33 deletions src/test/ui/check-cfg/mix.stderr
Original file line number Diff line number Diff line change
Expand Up @@ -7,154 +7,168 @@ LL | #[cfg(widnows)]
= note: `#[warn(unexpected_cfgs)]` on by default

warning: unexpected `cfg` condition value
--> $DIR/mix.rs:21:7
--> $DIR/mix.rs:18:7
|
LL | #[cfg(feature = "bar")]
| ^^^^^^^^^^^^^^^
|
= note: expected values for `feature` are: foo

warning: unexpected `cfg` condition value
--> $DIR/mix.rs:22:7
|
LL | #[cfg(feature = "zebra")]
| ^^^^^^^^^^^^^^^^^
|
= note: expected values for `feature` are: bar, foo
= note: expected values for `feature` are: foo

warning: unexpected `cfg` condition name
--> $DIR/mix.rs:25:12
--> $DIR/mix.rs:26:12
|
LL | #[cfg_attr(uu, test)]
| ^^

warning: unexpected `cfg` condition name
--> $DIR/mix.rs:34:10
--> $DIR/mix.rs:35:10
|
LL | cfg!(widnows);
| ^^^^^^^ help: did you mean: `windows`

warning: unexpected `cfg` condition value
--> $DIR/mix.rs:38:10
|
LL | cfg!(feature = "bar");
| ^^^^^^^^^^^^^^^
|
= note: expected values for `feature` are: foo

warning: unexpected `cfg` condition value
--> $DIR/mix.rs:40:10
|
LL | cfg!(feature = "zebra");
| ^^^^^^^^^^^^^^^^^
|
= note: expected values for `feature` are: bar, foo
= note: expected values for `feature` are: foo

warning: unexpected `cfg` condition name
--> $DIR/mix.rs:40:10
--> $DIR/mix.rs:42:10
|
LL | cfg!(xxx = "foo");
| ^^^^^^^^^^^

warning: unexpected `cfg` condition name
--> $DIR/mix.rs:42:10
--> $DIR/mix.rs:44:10
|
LL | cfg!(xxx);
| ^^^

warning: unexpected `cfg` condition name
--> $DIR/mix.rs:44:14
--> $DIR/mix.rs:46:14
|
LL | cfg!(any(xxx, windows));
| ^^^

warning: unexpected `cfg` condition value
--> $DIR/mix.rs:46:14
--> $DIR/mix.rs:48:14
|
LL | cfg!(any(feature = "bad", windows));
| ^^^^^^^^^^-----
| |
| help: did you mean: `"bar"`
| ^^^^^^^^^^^^^^^
|
= note: expected values for `feature` are: bar, foo
= note: expected values for `feature` are: foo

warning: unexpected `cfg` condition name
--> $DIR/mix.rs:48:23
--> $DIR/mix.rs:50:23
|
LL | cfg!(any(windows, xxx));
| ^^^

warning: unexpected `cfg` condition name
--> $DIR/mix.rs:50:20
--> $DIR/mix.rs:52:20
|
LL | cfg!(all(unix, xxx));
| ^^^

warning: unexpected `cfg` condition name
--> $DIR/mix.rs:52:14
--> $DIR/mix.rs:54:14
|
LL | cfg!(all(aa, bb));
| ^^

warning: unexpected `cfg` condition name
--> $DIR/mix.rs:52:18
--> $DIR/mix.rs:54:18
|
LL | cfg!(all(aa, bb));
| ^^

warning: unexpected `cfg` condition name
--> $DIR/mix.rs:55:14
--> $DIR/mix.rs:57:14
|
LL | cfg!(any(aa, bb));
| ^^

warning: unexpected `cfg` condition name
--> $DIR/mix.rs:55:18
--> $DIR/mix.rs:57:18
|
LL | cfg!(any(aa, bb));
| ^^

warning: unexpected `cfg` condition value
--> $DIR/mix.rs:58:20
--> $DIR/mix.rs:60:20
|
LL | cfg!(any(unix, feature = "zebra"));
| ^^^^^^^^^^^^^^^^^
|
= note: expected values for `feature` are: bar, foo
= note: expected values for `feature` are: foo

warning: unexpected `cfg` condition name
--> $DIR/mix.rs:60:14
--> $DIR/mix.rs:62:14
|
LL | cfg!(any(xxx, feature = "zebra"));
| ^^^

warning: unexpected `cfg` condition value
--> $DIR/mix.rs:60:19
--> $DIR/mix.rs:62:19
|
LL | cfg!(any(xxx, feature = "zebra"));
| ^^^^^^^^^^^^^^^^^
|
= note: expected values for `feature` are: bar, foo
= note: expected values for `feature` are: foo

warning: unexpected `cfg` condition name
--> $DIR/mix.rs:63:14
--> $DIR/mix.rs:65:14
|
LL | cfg!(any(xxx, unix, xxx));
| ^^^

warning: unexpected `cfg` condition name
--> $DIR/mix.rs:63:25
--> $DIR/mix.rs:65:25
|
LL | cfg!(any(xxx, unix, xxx));
| ^^^

warning: unexpected `cfg` condition value
--> $DIR/mix.rs:66:14
--> $DIR/mix.rs:68:14
|
LL | cfg!(all(feature = "zebra", feature = "zebra", feature = "zebra"));
| ^^^^^^^^^^^^^^^^^
|
= note: expected values for `feature` are: bar, foo
= note: expected values for `feature` are: foo

warning: unexpected `cfg` condition value
--> $DIR/mix.rs:66:33
--> $DIR/mix.rs:68:33
|
LL | cfg!(all(feature = "zebra", feature = "zebra", feature = "zebra"));
| ^^^^^^^^^^^^^^^^^
|
= note: expected values for `feature` are: bar, foo
= note: expected values for `feature` are: foo

warning: unexpected `cfg` condition value
--> $DIR/mix.rs:66:52
--> $DIR/mix.rs:68:52
|
LL | cfg!(all(feature = "zebra", feature = "zebra", feature = "zebra"));
| ^^^^^^^^^^^^^^^^^
|
= note: expected values for `feature` are: bar, foo
= note: expected values for `feature` are: foo

warning: 23 warnings emitted
warning: 25 warnings emitted