add more details about cargo fetch and when it will regen cargo.lock #15483
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
rustbot
added
A-documenting-cargo-itself
weihanglo
reviewed
May 2, 2025
| If the lock file is not compatible with the current `Cargo.toml`, then this | ||
| command will initiate dependency resolution from the current `Cargo.toml` file, | ||
| and update the lock file. | ||
|
|
There was a problem hiding this comment.
https://doc.rust-lang.org/nightly/cargo/commands/cargo-fetch.html#option-cargo-fetch---locked
This is mentioned in --locked flag. Unsure if we need to emphasize it here.
There was a problem hiding this comment.
Also, if we change something, we should probably think holistically. This isn't the only command like this.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this PR try to resolve?
I found the docs on
cargo fetchunclear with respect to whether or not it will regenerate the Cargo.lock file. This PR just adds some clarity on when it will actually rebuild it.How should we test and review this PR?
Just read the docs change and see if it makes sense or needs to be rewritten.