Document how to debug change detection events #10708
Conversation
|
Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @ehuss (or someone else) soon. Please see the contribution instructions for more information. |
rust-highfive
added
the
S-waiting-on-review
|
Thanks for the patch. There is already a whole paragraph explaining how to diagnose a rebuild. I would try not to duplicate the content. Either leave it as it was or a simple link to that paragraph is fine with me. |
|
Oh wow, you're correct. I totally didn't find it there though! The section you linked is well written and would indeed render my changes completely obsolete. I'll propose to link it instead. |
This merely links to the FAQ which already explains this topic very well.
|
@weihanglo Alright, fixed it according to your suggestion. |
|
@bors r+ |
|
📌 Commit 16e4c29 has been approved by |
bors
added
S-waiting-on-bors
|
☀️ Test successful - checks-actions |
Update cargo 5 commits in 39ad1039d9e3e1746177bf5d134af4c164f95528..38472bc19f2f76e245eba54a6e97ee6821b3c1db 2022-05-25 00:50:02 +0000 to 2022-05-31 02:03:24 +0000 - Emit warning upon encountering multiple packages with the same name (rust-lang/cargo#10701) - Guide new users to add use `super::*;` to `mod test` (rust-lang/cargo#10706) - Document how to debug change detection events (rust-lang/cargo#10708) - fix(publish): add more check when use `publish -p <SPEC>` (rust-lang/cargo#10677) - fix key formatting when switching to a dotted `WorkspaceSource` (rust-lang/cargo#10705)
What does this PR try to resolve?
I noticed that my build would sometimes seemingly randomly rebuild other crates. I figured this must be the build script detecting a change in some external files. In order to debug this, I figured I'd look at the Cargo sources whether something like this was already being logged. Thankfully, the logging for this was already in place but I didn't find it documented anyway so I thought it might be rather helpful in such scenarios.
I believe it's a common enough scenario that inclusion into the official documentation on this topic should be considered.
How should we test and review this PR?
Build/view documentation.
Additional information