Skip to content
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

Jump to bottom

Document how to debug change detection events #10708

Merged
merged 1 commit into from
May 27, 2022
Merged

Document how to debug change detection events #10708

merged 1 commit into from
May 27, 2022

Conversation

svenstaro
Copy link
Contributor

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

@rust-highfive
Copy link

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 rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label May 27, 2022
@weihanglo
Copy link
Member

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.

@svenstaro
Copy link
Contributor Author

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.

@svenstaro
Document how to debug change detection events
16e4c29 
This merely links to the FAQ which already explains this
topic very well.
@svenstaro
Copy link
Contributor Author

@weihanglo Alright, fixed it according to your suggestion.

weihanglo
weihanglo approved these changes May 27, 2022
View reviewed changes
Copy link
Member

@weihanglo weihanglo left a comment

Choose a reason for hiding this comment

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

Thank you!

@weihanglo
Copy link
Member

@bors r+

@bors
Copy link
Contributor

bors commented May 27, 2022

📌 Commit 16e4c29 has been approved by weihanglo

@bors bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels May 27, 2022
@bors
Copy link
Contributor

bors commented May 27, 2022

⌛ Testing commit 16e4c29 with merge e0e1df9...

@bors
Copy link
Contributor

bors commented May 27, 2022

☀️ Test successful - checks-actions
Approved by: weihanglo
Pushing e0e1df9 to master...

@bors bors merged commit e0e1df9 into rust-lang:master May 27, 2022
@svenstaro svenstaro deleted the patch-1 branch May 28, 2022 05:04
@ehuss ehuss mentioned this pull request Jun 1, 2022
Merged
bors added a commit to rust-lang-ci/rust that referenced this pull request Jun 1, 2022
@bors
Auto merge of rust-lang#97612 - ehuss:update-cargo, r=ehuss
12cd71f 
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)
@ehuss ehuss added this to the 1.63.0 milestone Jun 22, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@weihanglo weihanglo weihanglo approved these changes

Assignees

@ehuss ehuss

Labels
S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion.
Projects
None yet
Milestone
1.63.0
Development

Successfully merging this pull request may close these issues.
5 participants
@svenstaro @rust-highfive @weihanglo @bors @ehuss