Add new `misleading_cfg_in_build_script` lint by GuillaumeGomez · Pull Request #153721 · rust-lang/rust

GuillaumeGomez · 2026-03-11T14:15:49Z

Fixes #125441.
Fixes rust-lang/rust-clippy#9419.

Take-over of rust-lang/rust-clippy#12862.

It was originally implemented in clippy but the clippy thought it made for sense for such a lint to be directly implemented in rustc. I applied all suggestions made on the original PR and also improved the code overall (added docs too).

So on a build.rs from cargo crate, we will check for any target_*, unix and windows cfg and warn about them.

Since you made the original review on clippy.

r? @Urgau

rustbot · 2026-03-11T14:15:53Z

Some changes occurred in check-cfg diagnostics

cc @Urgau

GuillaumeGomez · 2026-03-11T14:35:29Z

Added a ui test to ensure this lint is only emitted on cargo build.rs scripts.

Urgau · 2026-03-11T18:06:22Z

+fn is_build_script(cx: &EarlyContext<'_>) -> bool {
+    rustc_session::utils::was_invoked_from_cargo()
+        && cx.sess().opts.crate_name.as_deref() == Some("build_script_build")
+}


This seems quite hacky and brittle for a lint.

Is there a better to detect if we are compiling a Cargo build script? If there isn't, we could maybe consider having the lint allowed by-default, but have Cargo implicitly set it to warn for build-scripts.

cc @rust-lang/cargo

Agreed, not great. :-/

I was kinda hoping that we had a "build script" crate kind but we don't (which is logical but still, not fun).

Just put it in t-cargo meeting agenda :)
next meeting time: Tue, Mar 17, 2026, 10:00 UTC-4

https://hackmd.io/-vJMV3isQfqu2d2J91t1eA

GuillaumeGomez · 2026-03-12T13:21:44Z

CI is finally happy. ^^'

ehuss · 2026-03-17T16:24:55Z

The cargo team discussed this today (notes). Some comments from that discussion:

We were largely OK with the approach of making this allow-by-default and having cargo set it to a warning when building a build script.
I was concerned about the possible amount of false-positives this would generate. Has there been a crater run or other analysis of what kind of false-positives this might hit? For example, if some build script has "cfg(windows) ... run executable that only exists on windows", it seems like this would be a false positive.
I assume this would need lang-team approval. It might be good to get this on their radar.
As an outsider looking at the diff, I am rather surprised to see yet another cfg parser being implemented here. I'm curious why this isn't using the standard cfg parser?

GuillaumeGomez · 2026-03-17T16:33:49Z

Sounds good.
It's a valid concern, to which I don't really have an answer to. Only answer is to run a crater run to see the impact it would have.
We're not clear which team is "in charge" here.
Unless I missed something, the cfg parser requires data I don't have? I'd love to be proven wrong though, would reduce the code quite a lot!

Urgau · 2026-03-17T18:26:14Z

I assume this would need lang-team approval. It might be good to get this on their radar.

I would expect a T-cargo FCP, with maybe T-compiler, but not T-lang. The lint proposed here has nothing to do with the language, it's purely a compiler and Cargo affair.

To elaborate a bit more, this lint could be in cargo it-self if we had a custom linting system, and it wouldn't need T-lang approval for that, so I don't think it needs one. We also (T-compiler) didn't ask T-lang to FCP the #[cfg]/--cfg lints.

As an outsider looking at the diff, I am rather surprised to see yet another cfg parser being implemented here. I'm curious why this isn't using the standard cfg parser?

I wouldn't look to closely at the impl. I haven't yet done a review of it, I wanted to wait for T-cargo input first.

Urgau

I share the concerns from Eric, about having another cfg parser.

Fortunately, this lint is simple enough that it can use the same infra as the unexpected_cfgs lint and perform the verification directly when parsing the cfgs them-selves in rustc_attr_parsing.

This will require some code re-shuffling between different crates (rustc_attr_parsing, rustc_lint_defs, rustc_lint, ...). You can follow what has been done for the UNEXPECTED_CFGS lint.

View changes since this review

ehuss · 2026-03-23T23:03:50Z

I would expect a T-cargo FCP, with maybe T-compiler, but not T-lang. The lint proposed here has nothing to do with the language, it's purely a compiler and Cargo affair.

I don't think that's how lints have been handled in the past. They all need to be approved by the lang team. I'm not aware of any exclusions.

GuillaumeGomez · 2026-03-23T23:05:29Z

I'm surprised: I added lints in the past without needing t-lang approval (although it might have been a few years for the last one... ^^').

Urgau · 2026-05-13T19:36:27Z

How does it look to you?

I haven't done yet a deep-dive review, but that looks pretty good.

Happy to see the logic moved directly in the parsing, it seems to simplify a bunch of things. Even perf seems to be happy.

I will try to do a review before RustWeek, otherwise it will after.

Urgau · 2026-05-29T17:11:44Z

Implementation seems fine to me.

@GuillaumeGomez what do say we do a crater run with the lint as deny-by-default to see the impact of the lint?

For the purpose of the Crater run (since we don't have Cargo support yet), I think we can check CARGO_CRATE_NAME=build_script_build to know if we are in a build script.

@rustbot label +needs-crater
@rustbot author

…t have a compiler output generated by the lint-docs script

…ustc lint

rustbot · 2026-05-29T22:01:49Z

Some changes occurred in check-cfg diagnostics

cc @Urgau

rustbot · 2026-05-29T22:01:52Z

This PR was rebased onto a different main commit. Here's a range-diff highlighting what actually changed.

Rebasing is a normal part of keeping PRs up to date, so no action is needed—this note is just to help reviewers.

GuillaumeGomez · 2026-05-29T22:02:35Z

@Urgau: Rebased and added one extra commit to change the lint level and trigger it on cargo build.rs. I'll let you start the crater run if it looks good to you.

rust-log-analyzer · 2026-05-29T22:40:38Z

The job aarch64-gnu-llvm-21-1 failed! Check out the build log: (web) (plain enhanced) (plain)

Click to see the possible cause of the failure (guessed by this bot)

error: ui test did not emit an error
note: by default, ui tests are expected not to compile.
hint: use check-pass, build-pass, or run-pass directive to change this behavior.
status: exit status: 0
command: env -u RUSTC_LOG_COLOR RUSTC_ICE="0" RUST_BACKTRACE="short" "/checkout/obj/build/aarch64-unknown-linux-gnu/stage2/bin/rustc" "/checkout/tests/ui/lint/misleading_cfg_in_build_script.rs" "-Zthreads=1" "-Zsimulate-remapped-rust-src-base=/rustc/FAKE_PREFIX" "-Ztranslate-remapped-path-to-local-path=no" "-Z" "ignore-directory-in-diagnostics-source-blocks=/cargo" "-Z" "ignore-directory-in-diagnostics-source-blocks=/checkout/vendor" "--sysroot" "/checkout/obj/build/aarch64-unknown-linux-gnu/stage2" "--target=aarch64-unknown-linux-gnu" "--error-format" "json" "--json" "future-incompat" "-Ccodegen-units=1" "-Zui-testing" "-Zdeduplicate-diagnostics=no" "-Zwrite-long-types-to-disk=no" "-Cstrip=debuginfo" "--emit" "metadata" "-C" "prefer-dynamic" "--out-dir" "/checkout/obj/build/aarch64-unknown-linux-gnu/test/ui/lint/misleading_cfg_in_build_script" "-A" "unused" "-W" "unused_attributes" "-A" "internal_features" "-A" "incomplete_features" "-A" "unused_parens" "-A" "unused_braces" "-Crpath" "-Cdebuginfo=0" "-Lnative=/checkout/obj/build/aarch64-unknown-linux-gnu/native/rust-test-helpers"
stdout: none
stderr: none

---- [ui] tests/ui/lint/misleading_cfg_in_build_script.rs stdout end ----

Urgau · 2026-05-30T11:25:33Z

@bors try

…, r=<try> Add new `misleading_cfg_in_build_script` lint

rust-bors · 2026-05-30T13:39:04Z

☀️ Try build successful (CI)
Build commit: dcc22e5 (dcc22e5232dd0dbe95a4b3ab84c8d24a0880771e, parent: 6eda7419e71fdbc1185ed5be7e6bff1a474ab5cd)

Urgau · 2026-05-30T14:05:15Z

@craterbot check

craterbot · 2026-05-30T14:05:39Z

👌 Experiment pr-153721 created and queued.
🤖 Automatically detected try build dcc22e5
🔍 You can check out the queue and this experiment's details.

ℹ️ Crater is a tool to run experiments across parts of the Rust ecosystem. Learn more

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 Mar 11, 2026

rustbot assigned Urgau Mar 11, 2026

GuillaumeGomez force-pushed the misleading_cfg_in_build_script branch from 262d2e2 to 3e99ab7 Compare March 11, 2026 14:35

This comment has been minimized.

Sign in to view

GuillaumeGomez force-pushed the misleading_cfg_in_build_script branch from 3e99ab7 to ea1c733 Compare March 11, 2026 16:00

This comment has been minimized.

Sign in to view

Urgau reviewed Mar 11, 2026

View reviewed changes

GuillaumeGomez force-pushed the misleading_cfg_in_build_script branch from ea1c733 to 28c7221 Compare March 11, 2026 20:58

This comment has been minimized.

Sign in to view

ehuss added the I-cargo-nominated Nominated for discussion during a cargo team meeting. label Mar 13, 2026

ehuss added this to Cargo status tracker Mar 17, 2026

ehuss moved this to Nominated in Cargo status tracker Mar 17, 2026

Urgau reviewed Mar 18, 2026

View reviewed changes

Comment thread compiler/rustc_lint/src/misleading_cfg_in_build_script.rs Outdated

Comment thread compiler/rustc_lint/src/misleading_cfg_in_build_script.rs Outdated

Comment thread compiler/rustc_lint/src/misleading_cfg_in_build_script.rs Outdated

GuillaumeGomez force-pushed the misleading_cfg_in_build_script branch from 2d14a6b to 06e2527 Compare March 19, 2026 13:34

This comment has been minimized.

Sign in to view

traviscross added T-lang Relevant to the language team I-lang-nominated Nominated for discussion during a lang team meeting. labels Mar 23, 2026

Urgau added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. perf-regression Performance regression. labels May 13, 2026

GuillaumeGomez force-pushed the misleading_cfg_in_build_script branch from 0ecdc4f to a114a87 Compare May 14, 2026 00:42

This comment has been minimized.

Sign in to view

GuillaumeGomez and others added 7 commits May 29, 2026 23:53

Make MetaItem::from_tokens public

5504d58

Add new misleading_cfg_in_build_script rustc lint

d0de35f

Add ui test for new misleading_cfg_in_build_script lint

220d02f

Add misleading_cfg_in_build_script to the list of lints which canno…

eff5bdd

…t have a compiler output generated by the lint-docs script

Remove is_build_script check for misleading_cfg_in_build_script r…

687857f

…ustc lint

Move misleading_cfg_in_build_script directly into attribute parsing

d6b9630

[TO REMOVE] Make lint deny by default and only run when build.rs

b547e5d

GuillaumeGomez force-pushed the misleading_cfg_in_build_script branch from a114a87 to b547e5d Compare May 29, 2026 22:01

This comment has been minimized.

Sign in to view

rust-bors Bot pushed a commit that referenced this pull request May 30, 2026

Auto merge of #153721 - GuillaumeGomez:misleading_cfg_in_build_script…

dcc22e5

…, r=<try> Add new `misleading_cfg_in_build_script` lint

craterbot added S-waiting-on-crater Status: Waiting on a crater run to be completed. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels May 30, 2026

Uh oh!

Conversation

GuillaumeGomez commented Mar 11, 2026 • edited by rustbot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

rustbot commented Mar 11, 2026

Uh oh!

GuillaumeGomez commented Mar 11, 2026

Uh oh!

This comment has been minimized.

This comment has been minimized.

Urgau Mar 11, 2026

Choose a reason for hiding this comment

Uh oh!

GuillaumeGomez Mar 11, 2026

Choose a reason for hiding this comment

Uh oh!

weihanglo Mar 13, 2026

Choose a reason for hiding this comment

Uh oh!

This comment has been minimized.

GuillaumeGomez commented Mar 12, 2026

Uh oh!

ehuss commented Mar 17, 2026

Uh oh!

GuillaumeGomez commented Mar 17, 2026

Uh oh!

Urgau commented Mar 17, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Urgau left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

This comment has been minimized.

ehuss commented Mar 23, 2026

Uh oh!

GuillaumeGomez commented Mar 23, 2026

Uh oh!

Urgau commented May 13, 2026

Uh oh!

This comment has been minimized.

Urgau commented May 29, 2026

Uh oh!

rustbot commented May 29, 2026

Uh oh!

rustbot commented May 29, 2026

Uh oh!

GuillaumeGomez commented May 29, 2026

Uh oh!

rust-log-analyzer commented May 29, 2026

Uh oh!

Urgau commented May 30, 2026

Uh oh!

This comment has been minimized.

rust-bors Bot commented May 30, 2026

Uh oh!

Urgau commented May 30, 2026

Uh oh!

craterbot commented May 30, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

12 participants

GuillaumeGomez commented Mar 11, 2026 •

edited by rustbot

Loading

Urgau commented Mar 17, 2026 •

edited

Loading

Urgau left a comment •

edited

Loading