feat(warnings): add build.warnings option#14388

arlosi · 2024-08-12T17:44:01Z

What does this PR try to resolve?

Allows control over warnings via a new Cargo configuration option build.warnings.

The primary use case is wanting CI runs to deny warnings, while keeping them as warnings for local development. While this is currently possible by conditionally setting RUSTFLAGS in CI, that approach is not available for projects that already use another mechanism for setting RUSTFLAGS, since the two would conflict. Additionally, we may in the future make this apply to more than warnings from rustc.

Adds build.warnings config option.

Option values:

deny emits an error if any warnings occurred
warn is the current existing behavior
allow hides the warnings

The option currently only applies to warnings coming from rustc, however it's documented as allowing additional categories of warnings from Cargo to be added.

Fixes #8424
Fixes #14258

How should we test and review this PR?

Tests are included in the PR. For local testing, after building cargo with this PR, run

CARGO_BUILD_WARNINGS=deny CARGO_UNSTABLE_WARNINGS=true cargo check

rustbot · 2024-08-12T17:44:06Z

r? @epage

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

tests/testsuite/warning_override.rs

bors · 2024-08-19T14:19:38Z

☔ The latest upstream changes (presumably #14423) made this pull request unmergeable. Please resolve the merge conflicts.

src/cargo/core/compiler/job_queue/mod.rs

src/doc/src/reference/unstable.md

tests/testsuite/warning_override.rs

epage · 2024-09-14T01:27:05Z

Thanks for the updates!

bors · 2024-10-08T21:48:35Z

☔ The latest upstream changes (presumably #14137) made this pull request unmergeable. Please resolve the merge conflicts.

src/cargo/util/context/mod.rs

tests/testsuite/warning_override.rs

bors · 2024-10-29T17:13:04Z

☔ The latest upstream changes (presumably #14743) made this pull request unmergeable. Please resolve the merge conflicts.

src/cargo/ops/cargo_compile/mod.rs

src/cargo/util/context/mod.rs

epage

CI failure needs to be looked at. I'm assuming its unrelated

tests/testsuite/fix.rs

Update cargo 16 commits in 0310497822a7a673a330a5dd068b7aaa579a265e..4a2d8dc636445b276288543882e076f254b3ae95 2024-11-01 19:27:56 +0000 to 2024-11-09 19:10:33 +0000 - test: adjust `cargo_test_env` to unblock rust submodule update (rust-lang/cargo#14803) - feat(warnings): add build.warnings option (rust-lang/cargo#14388) - Revert "feat: Add `CARGO_RUSTC_CURRENT_DIR`" (rust-lang/cargo#14799) - CI: make the `lint-docs` job required (rust-lang/cargo#14797) - Switch CI from bors to merge queue (rust-lang/cargo#14718) - docs(test): Document Execs assertions based on port effort (rust-lang/cargo#14793) - fix(test): Make redactions consistent with snapbox (rust-lang/cargo#14790) - test(gc): Update remaining unordered tests to snapbox (rust-lang/cargo#14785) - Normalize the `target` paths (rust-lang/cargo#14497) - rustfix: replace special-case duplicate handling with error (rust-lang/cargo#14782) - test: Update some emaining unordered tests to snapbox (rust-lang/cargo#14781) - Change config paths to only check CARGO_HOME for cargo-script (rust-lang/cargo#14749) - Enable transfer feature in triagebot (rust-lang/cargo#14777) - Add transactional semantics to `rustfix` (rust-lang/cargo#14747) - doc: fix `GlobalContext` reference (rust-lang/cargo#14773) - chore: update handlebars to v6, fix build error (rust-lang/cargo#14772)

rustbot assigned epage Aug 12, 2024

arlosi mentioned this pull request Aug 12, 2024

Add option to error when warnings are emitted, or ignore warnings #12875

Closed

epage reviewed Aug 12, 2024

View reviewed changes

tests/testsuite/warning_override.rs Outdated Show resolved Hide resolved

epage reviewed Aug 12, 2024

View reviewed changes

tests/testsuite/warning_override.rs Outdated Show resolved Hide resolved

epage reviewed Aug 12, 2024

View reviewed changes

tests/testsuite/warning_override.rs Outdated Show resolved Hide resolved

epage mentioned this pull request Aug 26, 2024

silence warnings in the terminal #14258

Closed

arlosi force-pushed the warnings2 branch from dbabfa2 to c3bad93 Compare September 12, 2024 17:20

rustbot added the A-workspaces Area: workspaces label Sep 12, 2024

arlosi force-pushed the warnings2 branch from c3bad93 to b7b9f87 Compare September 13, 2024 20:37