Document warning suppression heuristic #14337
Labels
A-documenting-cargo-itself
Area: Cargo's documentation
C-bug
Category: bug
S-triage
Status: This issue is waiting on initial triage.
Problem
Cargo suppresses warnings from depdendencies that are pulled in via git or crates.io. For path dependencies, warnings are shown.
I discovered this when I was patching a depdendency locally in a project that is compiled with
-D warnings
. There, the exact same crate that worked fine when pulled in via crates.io / git failed to compile when using a path dependency. That was pretty surprising and took me a while to figure out.I searched online but couldn't find any official documentation of this behavior. I think the heuristic makes sense, but it should be mentioned in the official docs.
Steps
I've created a small repo that demonstrates the different behavior for git and path dependencies: https://github.com/felixwrt/cargo_warning_heuristic
Possible Solution(s)
Add some docs to the cargo book that explain this behavior.
Notes
I really hope I didn't miss that it's already in the docs. If that's the case: sry for the noise!
Version
The text was updated successfully, but these errors were encountered: