summary refs log tree commit diff
path: root/src/doc/rustc-dev-guide
diff options
context:
space:
mode:
authorEric Huss <eric@huss.org>2022-05-20 20:53:51 -0700
committerGitHub <noreply@github.com>2022-05-21 12:53:51 +0900
commit5fd3d1dde7c7e90fdc1345b4495f56c373818ffa (patch)
tree2a07706efb6d0198f984a416420e2117d5e281f3 /src/doc/rustc-dev-guide
parentf1ad54fe583bafaf83a9a32fdfcb64eaa966c24d (diff)
downloadrust-5fd3d1dde7c7e90fdc1345b4495f56c373818ffa.tar.gz
rust-5fd3d1dde7c7e90fdc1345b4495f56c373818ffa.zip
Add note about patching dependencies and warnings. (#1354)
Diffstat (limited to 'src/doc/rustc-dev-guide')
-rw-r--r--src/doc/rustc-dev-guide/src/building/new-target.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/src/doc/rustc-dev-guide/src/building/new-target.md b/src/doc/rustc-dev-guide/src/building/new-target.md
index b5fc2cb0ad2..f216ed0b767 100644
--- a/src/doc/rustc-dev-guide/src/building/new-target.md
+++ b/src/doc/rustc-dev-guide/src/building/new-target.md
@@ -104,6 +104,12 @@ index be15e50e2bc..4fb1248ba99 100644
 
 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.
+
 [`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