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.

Sign up for GitHub

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

Jump to bottom

Improve well known value check-cfg diagnostic for the standard library #127221

Merged
merged 1 commit into from
Jul 6, 2024
Merged

Improve well known value check-cfg diagnostic for the standard library #127221

merged 1 commit into from
Jul 6, 2024

Conversation

Urgau
Copy link
Member

@Urgau Urgau commented Jul 1, 2024

This PR adjust the current logic for hidding the rustc/Cargo suggestion to add a value to a well-known name to exclude the standard library and rustc crates.

This is done in order to improve the contributor experience, in particular when adding a new target, which often requires adding some cfgs like target_os which may not be available yet in stage0.

The diagnostic code would look like this.

error: unexpected `cfg` condition value: `blable`
   --> library/core/src/lib.rs:369:7
    |
369 | #[cfg(target_os = "blable")]
    |       ^^^^^^^^^^^^^^^^^^^^
    |
    = note: expected values for `target_os` are: `aix`, `android`, `cuda`, `dragonfly`, `emscripten`, `espidf`, `freebsd`, `fuchsia`, `haiku`, `hermit`, `horizon`, `hurd`, `illumos`, `ios`, `l4re`, `linux`, `macos`, `netbsd`, `none`, `nto`, `openbsd`, `psp`, `redox`, `solaris`, `solid_asp3`, `teeos`, `tvos`, `uefi`, `unknown`, `visionos`, `vita`, `vxworks`, `wasi`, `watchos`, and `windows` and 2 more
    = help: consider using a Cargo feature instead
    = help: or consider adding in `Cargo.toml` the `check-cfg` lint config for the lint:
             [lints.rust]
             unexpected_cfgs = { level = "warn", check-cfg = ['cfg(target_os, values("blable"))'] }
    = help: or consider adding `println!("cargo::rustc-check-cfg=cfg(target_os, values(\"blable\"))");` to the top of the `build.rs`
    = note: see <https://doc.rust-lang.org/nightly/rustc/check-cfg/cargo-specifics.html> for more information about checking conditional configuration
    = note: `-D unexpected-cfgs` implied by `-D warnings`
    = help: to override `-D warnings` add `#[allow(unexpected_cfgs)]`

@rustbot
Copy link
Collaborator

rustbot commented Jul 1, 2024

r? @pnkfelix

rustbot has assigned @pnkfelix.
They will have a look at your PR within the next two weeks and either review your PR or reassign to another reviewer.

Use r? to explicitly pick a reviewer

@rustbot rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-compiler Relevant to the compiler team, which will review and decide on the PR/issue. labels Jul 1, 2024
@pnkfelix
Copy link
Member

pnkfelix commented Jul 5, 2024

@bors r+ rollup

@bors
Copy link
Contributor

bors commented Jul 5, 2024

📌 Commit 9e12d91 has been approved by pnkfelix

It is now in the queue for this repository.

@bors bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Jul 5, 2024
workingjubilee added a commit to workingjubilee/rustc that referenced this pull request Jul 5, 2024
@workingjubilee
Rollup merge of rust-lang#127221 - Urgau:check-cfg-std-diag, r=pnkfelix
e9daf66 
Improve well known value check-cfg diagnostic for the standard library

This PR adjust the current logic for hidding the rustc/Cargo suggestion to add a value to a well-known name to exclude the standard library and rustc crates.

This is done in order to improve the contributor experience, in particular when adding a new target, which often requires adding some cfgs like `target_os` which may not be available yet in stage0.

<details>

The diagnostic code would look like this.

```text
error: unexpected `cfg` condition value: `blable`
   --> library/core/src/lib.rs:369:7
    |
369 | #[cfg(target_os = "blable")]
    |       ^^^^^^^^^^^^^^^^^^^^
    |
    = note: expected values for `target_os` are: `aix`, `android`, `cuda`, `dragonfly`, `emscripten`, `espidf`, `freebsd`, `fuchsia`, `haiku`, `hermit`, `horizon`, `hurd`, `illumos`, `ios`, `l4re`, `linux`, `macos`, `netbsd`, `none`, `nto`, `openbsd`, `psp`, `redox`, `solaris`, `solid_asp3`, `teeos`, `tvos`, `uefi`, `unknown`, `visionos`, `vita`, `vxworks`, `wasi`, `watchos`, and `windows` and 2 more
    = help: consider using a Cargo feature instead
    = help: or consider adding in `Cargo.toml` the `check-cfg` lint config for the lint:
             [lints.rust]
             unexpected_cfgs = { level = "warn", check-cfg = ['cfg(target_os, values("blable"))'] }
    = help: or consider adding `println!("cargo::rustc-check-cfg=cfg(target_os, values(\"blable\"))");` to the top of the `build.rs`
    = note: see <https://doc.rust-lang.org/nightly/rustc/check-cfg/cargo-specifics.html> for more information about checking conditional configuration
    = note: `-D unexpected-cfgs` implied by `-D warnings`
    = help: to override `-D warnings` add `#[allow(unexpected_cfgs)]`
```

</details>
@workingjubilee workingjubilee mentioned this pull request Jul 5, 2024
Closed
bors added a commit to rust-lang-ci/rust that referenced this pull request Jul 5, 2024
@bors
Auto merge of rust-lang#127400 - workingjubilee:rollup-9894l8q, r=wor…
d956223 
…kingjubilee

Rollup of 11 pull requests

Successful merges:

 - rust-lang#123600 (impl PathBuf::add_extension and Path::with_added_extension)
 - rust-lang#126987 (out_of_scope_macro_calls: Detect calls inside attributes more precisely)
 - rust-lang#127107 (Improve dead code analysis)
 - rust-lang#127221 (Improve well known value check-cfg diagnostic for the standard library)
 - rust-lang#127333 (Split `SolverDelegate` back out from `InferCtxtLike`)
 - rust-lang#127363 (Improve readability of some fmt code examples)
 - rust-lang#127366 (Use `ControlFlow` results for visitors that are only looking for a single value)
 - rust-lang#127368 (Added dots at the sentence ends of rustc AST doc)
 - rust-lang#127369 (Match ergonomics 2024: align with RFC again)
 - rust-lang#127383 (Use verbose style for argument removal suggestion)
 - rust-lang#127393 (Remove clubby789 from review rotation)

r? `@ghost`
`@rustbot` modify labels: rollup
@compiler-errors compiler-errors mentioned this pull request Jul 6, 2024
Merged
bors added a commit to rust-lang-ci/rust that referenced this pull request Jul 6, 2024
@bors
Auto merge of rust-lang#127403 - compiler-errors:rollup-x2yb5t0, r=co…
51917e2 
…mpiler-errors

Rollup of 8 pull requests

Successful merges:

 - rust-lang#123600 (impl PathBuf::add_extension and Path::with_added_extension)
 - rust-lang#127107 (Improve dead code analysis)
 - rust-lang#127221 (Improve well known value check-cfg diagnostic for the standard library)
 - rust-lang#127333 (Split `SolverDelegate` back out from `InferCtxtLike`)
 - rust-lang#127363 (Improve readability of some fmt code examples)
 - rust-lang#127366 (Use `ControlFlow` results for visitors that are only looking for a single value)
 - rust-lang#127368 (Added dots at the sentence ends of rustc AST doc)
 - rust-lang#127393 (Remove clubby789 from review rotation)

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit 865518d into rust-lang:master Jul 6, 2024
6 checks passed
@rustbot rustbot added this to the 1.81.0 milestone Jul 6, 2024
rust-timer added a commit to rust-lang-ci/rust that referenced this pull request Jul 6, 2024
@rust-timer
Unrolled build for rust-lang#127221
9a9ad65 
Rollup merge of rust-lang#127221 - Urgau:check-cfg-std-diag, r=pnkfelix

Improve well known value check-cfg diagnostic for the standard library

This PR adjust the current logic for hidding the rustc/Cargo suggestion to add a value to a well-known name to exclude the standard library and rustc crates.

This is done in order to improve the contributor experience, in particular when adding a new target, which often requires adding some cfgs like `target_os` which may not be available yet in stage0.

<details>

The diagnostic code would look like this.

```text
error: unexpected `cfg` condition value: `blable`
   --> library/core/src/lib.rs:369:7
    |
369 | #[cfg(target_os = "blable")]
    |       ^^^^^^^^^^^^^^^^^^^^
    |
    = note: expected values for `target_os` are: `aix`, `android`, `cuda`, `dragonfly`, `emscripten`, `espidf`, `freebsd`, `fuchsia`, `haiku`, `hermit`, `horizon`, `hurd`, `illumos`, `ios`, `l4re`, `linux`, `macos`, `netbsd`, `none`, `nto`, `openbsd`, `psp`, `redox`, `solaris`, `solid_asp3`, `teeos`, `tvos`, `uefi`, `unknown`, `visionos`, `vita`, `vxworks`, `wasi`, `watchos`, and `windows` and 2 more
    = help: consider using a Cargo feature instead
    = help: or consider adding in `Cargo.toml` the `check-cfg` lint config for the lint:
             [lints.rust]
             unexpected_cfgs = { level = "warn", check-cfg = ['cfg(target_os, values("blable"))'] }
    = help: or consider adding `println!("cargo::rustc-check-cfg=cfg(target_os, values(\"blable\"))");` to the top of the `build.rs`
    = note: see <https://doc.rust-lang.org/nightly/rustc/check-cfg/cargo-specifics.html> for more information about checking conditional configuration
    = note: `-D unexpected-cfgs` implied by `-D warnings`
    = help: to override `-D warnings` add `#[allow(unexpected_cfgs)]`
```

</details>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@pnkfelix pnkfelix

Labels
S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. T-compiler Relevant to the compiler team, which will review and decide on the PR/issue.
Projects
None yet
Milestone
1.81.0
Development

Successfully merging this pull request may close these issues.
4 participants
@Urgau @rustbot @pnkfelix @bors