[SymbolGraphGen] add flags to filter platforms out of availability metadata #80778
+155
−3
Conversation
This file contains 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
QuietMisdreavus
requested review from
a team,
artemcm and
tshortli
as code owners
|
@swift-ci Please smoke test |
d-ronnqvist
approved these changes
Apr 14, 2025
anferbui
approved these changes
Apr 14, 2025
include/swift/Option/Options.td
Outdated
| @@ -1774,6 +1774,16 @@ def symbol_graph_minimum_access_level: Separate<["-"], "symbol-graph-minimum-acc | |||
| HelpText<"Include symbols with this access level or more when emitting a symbol graph">, | |||
| MetaVarName<"<level>">; | |||
|
|
|||
| def symbol_graph_availability_platforms: Separate<["-"], "symbol-graph-availability-platforms">, | |||
| Flags<[FrontendOption, NoInteractiveOption, SupplementaryOutput, HelpHidden]>, | |||
| HelpText<"Restrict availability metadata to the given platforms, e.g. 'macOS,swift'">, | |||
There was a problem hiding this comment.
Since the casing matters here, should this example be Swift?
Suggested change
| HelpText<"Restrict availability metadata to the given platforms, e.g. 'macOS,swift'">, | |
| HelpText<"Restrict availability metadata to the given platforms, e.g. 'macOS,Swift'">, |
Should we also mention here about the capitalization needing to match the domains emitted in the symbol graph?
include/swift/Option/Options.td
Outdated
|
|
||
| def symbol_graph_block_availability_platforms: Separate<["-"], "symbol-graph-block-availability-platforms">, | ||
| Flags<[FrontendOption, NoInteractiveOption, SupplementaryOutput, HelpHidden]>, | ||
| HelpText<"Remove the given platforms from symbol graph availability metadata, e.g. 'macOS,swift'">, |
include/swift/Option/Options.td
Outdated
| @@ -1788,6 +1798,16 @@ def omit_extension_block_symbols: Flag<["-"], "omit-extension-block-symbols">, | |||
| NoInteractiveOption, SupplementaryOutput, HelpHidden]>, | |||
| HelpText<"Directly associate members and conformances with the extended nominal when generating symbol graphs instead of emitting 'swift.extension' symbols for extensions to external types">; | |||
|
|
|||
| def availability_platforms: Separate<["-"], "availability-platforms">, | |||
| Flags<[SwiftSymbolGraphExtractOption]>, | |||
| HelpText<"Restrict availability metadata to the given platforms, e.g. 'macOS,swift'">, | |||
include/swift/Option/Options.td
Outdated
|
|
||
| def block_availability_platforms: Separate<["-"], "block-availability-platforms">, | ||
| Flags<[SwiftSymbolGraphExtractOption]>, | ||
| HelpText<"Remove the given platforms from symbol graph availability metadata, e.g. 'macOS,swift'">, |
I think this makes sense. I didn't include "allow" or similar in the flag name to begin with because in my head it conflict with the behavior of "restrict everything else", but maybe having the dichotomy of "allow" versus "block" will make that clearer. I can go ahead and add that. |
|
@swift-ci Please smoke test |
|
@swift-ci Please smoke test macOS |
QuietMisdreavus
added a commit
that referenced
this pull request
Apr 14, 2025
…tadata (#80778) * add option to filter availability metadata in symbol graphs * filter out platform-specific availability in the stdlib docs rdar://144379124
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.
Resolves rdar://144379124
This PR adds two new flags to swift-frontend and two counterpart flags to
swift-symbolgraph-extract, to control the platforms added to availability metadata in symbol graphs.-symbol-graph-availability-platforms(swift-frontend) and-availability-platforms(swift-symbolgraph-extract) set an allow-list of platform names to emit the symbol graph. The capitalization needs to match the domains emitted in the symbol graph (e.g.Swift,iOS,Windows,OpenBSD, etc). An empty string can be passed to this option to filter out all platform-specific availability information.-symbol-graph-block-availability-platforms(swift-frontend) and-block-availability-platforms(swift-symbolgraph-extract) do the inverse: They set a deny-list of platform names.None of these options will filter out "unconditional" availability, like
@available(*, deprecated)or anything else defined on the*domain.In addition, this PR updates the
--build-stdlib-docsand--preview-stdlib-docscommands inbuild-scriptto set an allow-list containing onlySwift, to clean up the availability information for local previews.