chore: fix unexpected cfg warning

[tottoto]

Fixes unexpected cfg warnings, which cause the ci fail.

https://doc.rust-lang.org/nightly/cargo/reference/build-scripts.html#rustc-check-cfg

[seanmonstar]

Started with rust-lang/cargo#13571

[seanmonstar]

A build file slows down compilation measurably. Can it be solved without?

[tottoto]

I think another workaround is to allow this lint.

[tottoto]

Changed to allow it.

[Darksonn]

Note that it's possible to add a ci check that still runs the lint, with your custom --cfgs allowed. See #6538.

[tottoto]

I have known it, but I do not think that it is a good idea to use --cfg for configs which are always intended to be given.

[Darksonn]

What do you mean by that?

[sfackler]

@dtolnay has a neat approach to avoid the build.rs build time penalty: tokio-rs/tokio#6542

[seanmonstar]

That's clever, but I think currently my preferred solution is to just allow the lint normally, and optionally add a CI job checking it.

[tottoto]

Updated to allow unexpected_cfgs as default and check it with a new ci job.

[Urgau]

Heads up, with the release of rust-lang/cargo#13913 (in nightly-2024-05-19), there is no longer any need for the kind of workarounds employed in this PR. Cargo has now gain the ability to declare --check-cfg args directly inside the [lints] table with [lints.rust.unexpected_cfgs.check-cfg]¹:

Cargo.toml:

[lints.rust]
unexpected_cfgs = { level = "warn", check-cfg = ['cfg(foo)'] }

Note that the diagnostic output of the lint has been updated to suggest the [lints] approach first. You can use it to guide you through the --check-cfg arguments that may need to be added.

Footnotes

1. take effect on Rust 1.80 (current nightly), is ignored on Rust 1.79 (current beta), and produce an unused warning below ↩