Recommend package.rust-version in the Rust version section of reference/semver.md.
#15806
+8
−0
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
Adds a recommendation that, to mitigate “possibly breaking” Rust version requirement increases, they should be declared using `package.rust-version`. My main goal in this change is to make it *possible to find* the Rust version section in this page by searching it, but the most appropriate way to fit it into this section seemed to me to be making this recommendation. Declaring (and maintaining) `package.rust-version` is additional work, but it is a much lesser burden on maintainers than other items in the same list such as "Provide a large window of support".
rustbot
added
A-documenting-cargo-itself
weihanglo
reviewed
Aug 5, 2025
epage
reviewed
Aug 5, 2025
Co-authored-by: Ed Page <[email protected]>
|
Mind cleaning up the commits into logical, atomic units rather than the history of how this was implemented? |
epage
reviewed
Sep 29, 2025
| to update their Rust toolchain rapidly. | ||
|
|
||
| Mitigation strategies: | ||
| * Specify your package’s minimum-supported Rust version by setting |
There was a problem hiding this comment.
If making changes to the history, one last tweak (I know, I recommended this wording):
Suggested change
| * Specify your package’s minimum-supported Rust version by setting | |
| * Document your package’s minimum-supported Rust version by setting |
This changes the base assumption to be that this item is for if you have an MSRV and so you likely also verify it. We have the note at the end about support considerations but people are likely to miss that when scanning through this.
I'm tempted to tweak this further to find a way to make it clear that an MSRV isn't always literally what compiles but not finding a great way, so leaving it.
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.
Adds a recommendation that, to mitigate “possibly breaking” Rust version requirement increases, they should be declared using
package.rust-version.My main goal in this change is to make it possible to find the Rust version section in this page by searching it, but the most appropriate way to fit it into this section seemed to me to be making this recommendation. Declaring (and maintaining)
package.rust-versionis additional work, but it is a much lesser burden on maintainers than other items in the same list such as "Provide a large window of support".