elaborate on warnings

This commit is contained in:
Noratrieb 2024-09-24 20:59:17 +02:00 committed by nora
parent bf46b0f7e7
commit 451d43fad7
1 changed files with 4 additions and 3 deletions

View File

@ -138,8 +138,10 @@ After this, run `cargo update -p libc` to update the lockfiles.
Beware that if you patch to a local `path` dependency, this will enable
warnings for that dependency. Some dependencies are not warning-free, and due
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.
to fail.
To work around 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
@ -147,7 +149,6 @@ in the config, or modify the dependency to remove the warnings.
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