Add clippy into the known `cfg` list by GuillaumeGomez · Pull Request #121137 · rust-lang/rust

GuillaumeGomez · 2024-02-15T10:42:21Z

In clippy, we are removing the feature = "cargo-clippy" cfg to replace it with clippy in rust-lang/rust-clippy#12292. But for it to work, we need to declare clippy as cfg. It makes it more coherent with other existing tools like rustdoc.

cc @flip1995

rustbot · 2024-02-15T10:42:29Z

r? @TaKO8Ki

rustbot has assigned @TaKO8Ki.
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

compiler/rustc_session/src/config.rs

Urgau · 2024-02-15T10:56:07Z

compiler/rustc_session/src/config.rs

        // These three are never set by rustc, but we set them anyway: they
        // should not trigger a lint because `cargo doc`, `cargo test`, and
        // `cargo miri run` (respectively) can set them.
+        ins!(sym::clippy, no_values);


It needs to be added in tests/ui/check-cfg/well-known-values.rs.

You will also probably need to bless the directory

Urgau · 2024-02-15T11:05:44Z

compiler/rustc_session/src/config.rs

        // These three are never set by rustc, but we set them anyway: they
        // should not trigger a lint because `cargo doc`, `cargo test`, and
        // `cargo miri run` (respectively) can set them.
+        ins!(sym::clippy, no_values);


The check-cfg section of the unstable book also needs updating:

rust/src/doc/unstable-book/src/compiler-flags/check-cfg.md

Lines 80 to 87 in 4ae1e79

As of `2024-01-09T`, the list of known names is as follows:



- `debug_assertions`

- `doc`

- `doctest`

- `miri`

Good catch!

The code here should have a comment mentioning the docs :)

Urgau · 2024-02-15T11:30:07Z

src/doc/unstable-book/src/compiler-flags/check-cfg.md


 <!--- See CheckCfg::fill_well_known in compiler/rustc_session/src/config.rs -->

+ - `clippy`


Would be great if you could also update the date above to 2024-02-15T

Urgau · 2024-02-15T11:31:50Z

tests/ui/check-cfg/well-known-values.rs

 fn doc() {}

+#[cfg(clippy)]
+fn clippy() {}


Could you also add the cfg above as to check that we only expect clippy and nothing else.

#[cfg(any( // tidy-alphabetical-start + clippy = "_UNEXPECTED_VALUE", + //~^ WARN unexpected `cfg` condition value debug_assertions = "_UNEXPECTED_VALUE", //~^ WARN unexpected `cfg` condition value

GuillaumeGomez · 2024-02-15T11:43:54Z

Updated! Thanks a lot for the reviews!

Urgau

Looks good, thanks.

Urgau · 2024-02-15T12:45:58Z

compiler/rustc_session/src/config.rs

+        // should not trigger a lint because `cargo doc`, `cargo test`,
+        // `cargo clippy` and `cargo miri run` (respectively) can set them.


nit:

Suggested change

// should not trigger a lint because `cargo doc`, `cargo test`,

// `cargo clippy` and `cargo miri run` (respectively) can set them.

// should not trigger a lint because `cargo clippy`, `cargo doc`,

// `cargo test` and `cargo miri run` (respectively) can set them.

Ok, let's alpha sort them. 😆

GuillaumeGomez · 2024-02-15T14:06:48Z

r? @compiler-errors

…r if the check-cfg list is updated

Noratrieb · 2024-02-15T20:58:37Z

Guillaume asked me to review the PR since I commented on it, and it looks good to me.
@bors r=Urgau,Nilstrieb

bors · 2024-02-15T20:58:40Z

📌 Commit 533e3f0 has been approved by Urgau,Nilstrieb

It is now in the queue for this repository.

flip1995 · 2024-02-16T10:00:49Z

@bors rollup

…llaumeGomez Rollup of 6 pull requests Successful merges: - rust-lang#119928 (suggest `into_iter()` when `Iterator` method called on `impl IntoIterator`) - rust-lang#121020 (Avoid an ICE in diagnostics) - rust-lang#121111 (For E0038, suggest associated type if available) - rust-lang#121137 (Add clippy into the known `cfg` list) - rust-lang#121179 (allow mutable references in const values when they point to no memory) - rust-lang#121181 (Fix an ICE in the recursion lint) r? `@ghost` `@rustbot` modify labels: rollup

Rollup merge of rust-lang#121137 - GuillaumeGomez:add-clippy-cfg, r=Urgau,Nilstrieb Add clippy into the known `cfg` list In clippy, we are removing the `feature = "cargo-clippy"` cfg to replace it with `clippy` in rust-lang/rust-clippy#12292. But for it to work, we need to declare `clippy` as cfg. It makes it more coherent with other existing tools like rustdoc. cc `@flip1995`

rustbot assigned TaKO8Ki Feb 15, 2024

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 Feb 15, 2024

GuillaumeGomez mentioned this pull request Feb 15, 2024

Add new lint DEPRECATED_CLIPPY_CFG_ATTR rust-lang/rust-clippy#12292

Merged

flip1995 reviewed Feb 15, 2024

View reviewed changes

compiler/rustc_session/src/config.rs Outdated Show resolved Hide resolved

Urgau reviewed Feb 15, 2024

View reviewed changes

This comment has been minimized.

Sign in to view

Urgau reviewed Feb 15, 2024

View reviewed changes

GuillaumeGomez force-pushed the add-clippy-cfg branch from 150cef9 to 2bffcbf Compare February 15, 2024 11:10

Urgau reviewed Feb 15, 2024

View reviewed changes

GuillaumeGomez force-pushed the add-clippy-cfg branch from 2bffcbf to a1c10e7 Compare February 15, 2024 11:43

This comment has been minimized.

Sign in to view

GuillaumeGomez force-pushed the add-clippy-cfg branch from a1c10e7 to 870127e Compare February 15, 2024 11:51

Urgau approved these changes Feb 15, 2024

View reviewed changes

GuillaumeGomez added 3 commits February 15, 2024 14:18

Add clippy into the known cfg list

0860fc1

Update ui tests to take into account the new clippy cfg

33e9fc5

Update rust book cfg chapter

4085421

GuillaumeGomez force-pushed the add-clippy-cfg branch from 870127e to 4085421 Compare February 15, 2024 13:18

rustbot assigned compiler-errors and unassigned TaKO8Ki Feb 15, 2024

Add comment to remind devs to update the unstable book related chapte…

533e3f0

…r if the check-cfg list is updated

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 Feb 15, 2024

GuillaumeGomez mentioned this pull request Feb 16, 2024

Rollup of 6 pull requests #121188

Merged

bors merged commit f60576b into rust-lang:master Feb 16, 2024

rustbot added this to the 1.78.0 milestone Feb 16, 2024

GuillaumeGomez deleted the add-clippy-cfg branch February 17, 2024 11:12

	As of `2024-01-09T`, the list of known names is as follows:

	<!--- See CheckCfg::fill_well_known in compiler/rustc_session/src/config.rs -->

	- `debug_assertions`
	- `doc`
	- `doctest`
	- `miri`


		<!--- See CheckCfg::fill_well_known in compiler/rustc_session/src/config.rs -->

		- `clippy`

		// should not trigger a lint because `cargo doc`, `cargo test`,
		// `cargo clippy` and `cargo miri run` (respectively) can set them.

Uh oh!

Comments

Conversation

GuillaumeGomez commented Feb 15, 2024

Uh oh!

rustbot commented Feb 15, 2024

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

This comment has been minimized.

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

GuillaumeGomez commented Feb 15, 2024

Uh oh!

This comment has been minimized.

Urgau left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

GuillaumeGomez commented Feb 15, 2024

Uh oh!

Noratrieb commented Feb 15, 2024

Uh oh!

bors commented Feb 15, 2024

Uh oh!

flip1995 commented Feb 16, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

9 participants