[docs] Describe how _alwaysEmitIntoClient relates to library evolution. #38814
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
beccadax
approved these changes
Aug 11, 2021
docs/LibraryEvolution.rst
Outdated
| - Adding ``@_alwaysEmitIntoClient`` to a declaration breaks ABI but is a | ||
| source-compatible change. | ||
| - Removing ``@_alwaysEmitIntoClient`` from a declaration is a | ||
| binary-compatible and source-compatible change. |
There was a problem hiding this comment.
I might modify this last point to something like:
- Removing ``@_alwaysEmitIntoClient`` from a declaration is a
binary-compatible and source-compatible change, but its
availability cannot be backdated earlier than the removal of
the attribute.
There was a problem hiding this comment.
I just realized, if the availability needs to be updated, then it does create a source break, right? Consider:
- A framework has
@available(macOS 10.15, *) @_alwaysEmitIntoClient public func fin Xcode 11.0. - App A compiles against Xcode 11.0 fine with minimum deployment target macOS 10.15 and uses
fwithout issues. - The framework removes the
@_alwaysEmitIntoClientin Xcode 12.0, and the availability is updated to
@available(macOS 11.0, *)(because the symbol isn't available on macOS 10.15 in the framework). - If App A tries to compile against the new SDK while maintaining macOS 10.15 as the deployment target, it will fail to compile.
varungandhi-apple
force-pushed
the
vg-aeic-lib-evo
branch
2 times, most recently
from
e5b6f61 to
299f1df
Compare
varungandhi-apple
force-pushed
the
vg-aeic-lib-evo
branch
from
299f1df to
4f69c2b
Compare
|
@swift-ci smoke test and merge |
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.
I also removed an admonition for stabilizing AEIC; I don't think these docs are the right place for that.
I will file separate tickets for tracking stabilization and desired changes to AEIC.