docs: Better document breaking change policy and recommended usage#5179
Open
tgross35 wants to merge 1 commit into
Open
docs: Better document breaking change policy and recommended usage#5179tgross35 wants to merge 1 commit into
tgross35 wants to merge 1 commit into
Conversation
For a while there has been an informal policy about what is and isn't allowed regarding breaking changes, but it hasn't been written down anywhere. This is an attempt to start to give our users some more concrete expectations, documented in the "Stability Expectations" section. I expect this will be updated as we think of more cases. I additionally added a "Usage Recommendations" section that is meant to give actionable suggestions about how to avoid breakage and other problems. Closes: rust-lang#5018
Contributor
Author
|
@JohnTitor I still need to re-read through this and make sure it actually makes sense, but I'd love your thoughts here when you get the chance. |
tgross35
added
the
stable-nominated
3 tasks
3 tasks
dybucc
added a commit
to dybucc/libc
that referenced
this pull request
Jun 18, 2026
This symbol has been modified in the last few versions of FreeBSD. It can possibly be assumed that the constant is likely to change upstream, and users should likely be advised of its use. The link in the doc comment is broken until rust-lang#5179 gets merged.
3 tasks
JohnTitor
approved these changes
Jun 19, 2026
| //! This feature is expected to be removed in libc 1.0. Libraries should instead hash or check | ||
| //! equality of only needed fields. | ||
| //! | ||
| //! - The features `const-extern-function`, `align`, and `use_std` are all deprecated. |
Member
There was a problem hiding this comment.
Suggested change
| //! - The features `const-extern-function`, `align`, and `use_std` are all deprecated. | |
| //! - The features `const-extern-fn`, `align`, and `use_std` are all deprecated. |
| //! relaxed API stability requirements, and API stability is not enforced on tier 3 targets. | ||
| //! | ||
| //! While this section seems scary, keep in mind that it is meant to cover worst-case scenarios. In | ||
| //! practice, breakage is rare and following the above-discussed [Best Practices](#best-practices) |
Member
There was a problem hiding this comment.
I might be missing something but I don't see this section.
| //! | ||
| //! # Usage Recommendations | ||
| //! | ||
| //! `libc` takes a differe |
dybucc
added a commit
to dybucc/libc
that referenced
this pull request
Jun 19, 2026
This symbol has been modified in the last few versions of FreeBSD. It can possibly be assumed that the constant is likely to change upstream, and users should likely be advised of its use. The link in the doc comment is broken until rust-lang#5179 gets merged.
dybucc
added a commit
to dybucc/libc
that referenced
this pull request
Jun 19, 2026
This symbol has been modified in the last few versions of FreeBSD. It can possibly be assumed that the constant is likely to change upstream, and users should likely be advised of its use. The link in the doc comment is broken until rust-lang#5179 gets merged.
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
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.
For a while there has been an informal policy about what is and isn't allowed regarding breaking changes, but it hasn't been written down anywhere. This is an attempt to start to give our users some more concrete expectations, documented in the "Stability Expectations" section. I expect this will be updated as we think of more cases.
I additionally added a "Usage Recommendations" section that is meant to give actionable suggestions about how to avoid breakage and other problems.
Closes: #5018