Repository navigation
Document how public APIs are obsoleted - #1117
Open
mauroservienti wants to merge 1 commit into
Open
mauroservienti wants to merge 1 commit into
mauroservienti wants to merge 1 commit into
Conversation
Public APIs are obsoleted with a warning in a minor, become an error in the next major, and are removed in the major after that. Since master builds the next major, the error goes to master and the warning to the release branch, through a separate backport.
This branch has not been deployed
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
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 an "Obsoleting public APIs" section to
RELEASING.md, and a pointer to it inCLAUDE.md.The policy:
N:[Obsolete]with a warning. The API keeps working.N+1.0.0:[Obsolete]with an error.N+2.0.0: removed.The obsolete message says what to use instead, and in which versions the API becomes an error and gets removed.
Because
masterbuilds the next major, obsoleting takes two pull requests: the error onmaster, and the warning as a backport to the release branch of the minor that ships it. That backport isn't a plain cherry-pick, since the attribute differs.The section also covers the follow-up steps:
N+2.0.0milestone;#pragmarather than a project-wideNoWarn.The first use will be
EnableCompositionOverControllers()(#1116).