Unify availability annotations & introduce a script to manage them #75
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
…OS 15 Availability annotations now follow a rigid syntax that mentions the swift-system version that introduced the entry point: ``` /*System 0.0.2, @available(macOS 12.0, iOS 15.0, watchOS 8.0, tvOS 15.0, *)*/ public func greeting() -> String { "Hello" } ``` This is designed to be processed by automated source generation tools.
By running this script, we can expand comments of the form ``` /*System 0.0.1*/ ``` Into either a longer comment that includes the associated OS versions numbers, ``` /*System 0.0.1, @available(macOS 11.0, iOS 14.0, watchOS 7.0, tvOS 14.0, *)*/ ``` or, when the `--attribute` option is used, into an actual `@available` attribute: ``` /*System 0.0.1*/@available(macOS 11.0, iOS 14.0, watchOS 7.0, tvOS 14.0, *) ``` The script can be run repeatedly to switch between these two forms, as needed.
Member
Author
|
@swift-ci test |
milseman
approved these changes
Dec 21, 2021
Contributor
milseman
left a comment
milseman
left a comment
There was a problem hiding this comment.
LGTM!
I mean it's kinda crazy you have to do this, but keep doing it!
Member
Author
|
@swift-ci test |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
Instead of spelling out availability incantations, contributors can now specify availability annotations using special comments that mention the swift-system version that will introduce the entry point:
The new script
Utilities/expand-availability.pycan then be used to augment these comments with the ABI-stable OS versions that introduced these:(The script updates these expansions every time it runs.)
When the script is run with the option
--attributes, it instead adds the availability incantation as an actual availability attribute:This can be used by package maintainers to generate the ABI stable variant of swift-system that ships in Apple's OS distributions.
The script recognizes all three forms of these annotations and updates them on every run, so we can run the script to enable/disable attributes as needed.