fix(patch): clean up patch-related error messages #16498
+64
−104
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
…le resolved candidates
rustbot
added
A-crate-dependencies
weihanglo
reviewed
Jan 11, 2026
Member
There was a problem hiding this comment.
Thanks for the pull request. Looks really nice!
I was thinking about (and tried) moving this portion of error messages directly to the annotate snippets #15944, but with several functions returning Result it was not straightforward. Probably needs well-thought refactoring, which is out of scope of this PR.
Yeah that one definitely need more legwork :)
| Caused by: | ||
| The patch location `[ROOT]/foo/bar` contains a `bar` package with version `0.1.0`, but the patch definition in `[ROOT]/foo/Cargo.toml` requires `^0.1.1`. | ||
| Check that the version in the patch location is what you expect, and update the patch definition to match. | ||
| [ERROR] patch `bar` version mismatch |
Member
There was a problem hiding this comment.
Thanks for the clean-up!
Some minor nits:
- First letter should be lowercase.
- We could have
noteandhelplevels here maybe, such as
error: patch `bar` version mismatch
note: patch location contains version `0.1.0`, but patch definition requires `^0.1.1`
help: check patch location `[ROOT]/foo/bar`
help: check `bar` patch definition for `https://github.com/rust-lang/crates.io-index`
| vers.sort(); | ||
| let versions: Vec<_> = vers.into_iter().map(|v| v.to_string()).collect(); | ||
| return Poll::Ready(Err(anyhow::anyhow!( | ||
| "patch for `{}` in `{}` resolved to more than one candidate\n\ |
Member
There was a problem hiding this comment.
No need to quite the second one (source)
| [ERROR] patch for `bar` in `registry `alternative`` resolved to more than one candidate | ||
| Found versions: 0.1.0, 0.1.1 | ||
| Check `bar` patch definition for `https://github.com/rust-lang/crates.io-index` in `[ROOT]/foo/Cargo.toml` | ||
| For example, select only one package using `version = "=0.1.1"` |
Member
There was a problem hiding this comment.
- we don't need to quote "registry
alternative" maybe?
What about this?
error: patch for `bar` in registry `alternative` resolved to more than one candidate
note: found versions: 0.1.0, 0.1.1
help: check `bar` patch definition for `https://github.com/rust-lang/crates.io-index` in `[ROOT]/foo/Cargo.toml`
help: select only one package, for example with `version = "=0.1.1"`
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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?
This is a follow-up for #16407.
This PR is supposed to make patch-related error messages closer to the desired style, remove unnecessary(?) context wrappings, and fix a few minor issues in code.
I tried to restructure some of the error messages to include the values from
.context()where I thought it would make sense. Obvious duplications (e.g. repository url of the patch) were removed.I tried to rephrase some of the error messages to sound closer to the desired style and to ease future migration to rustc's error reporter.
How to test and review this PR?
Test changes should demonstrate the intended behavior change.
Suggestions on how to make messages even better are obviously welcome.
Note
I was thinking about (and tried) moving this portion of error messages directly to the annotate snippets #15944, but with several functions returning
Resultit was not straightforward. Probably needs well-thought refactoring, which is out of scope of this PR.r? @weihanglo