Skip to content

Clarify how to disable warnings in deps #2015

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Sep 24, 2024
Merged

Clarify how to disable warnings in deps #2015

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f66f053
Clarify how to disable warnings in deps
nyurik Jul 18, 2024
db318ea
Apply suggestions from code review
nyurik Sep 23, 2024
239b5ac
elaborate on warnings
Noratrieb Sep 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions src/building/new-target.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,13 @@ to the `deny-warnings` setting in `config.toml`, the build may suddenly start
to fail. To work around the warnings, you may want to disable `deny-warnings`
in the config, or modify the dependency to remove the warnings.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggestion: we should clarify this sentence:

To workaround warnings, you may want to:

  • Modify the dependency to remove the warnings
  • Or for local development purposes, suppress the warnings by setting deny-warnings = false in config.toml.


```toml
# /config.toml
[rust]
deny-warnings = false
```


[`libc`]: https://crates.io/crates/libc
[`cc`]: https://crates.io/crates/cc
[patch]: https://doc.rust-lang.org/stable/cargo/reference/overriding-dependencies.html#the-patch-section
Expand Down