Skip to content

[docs] Describe how _alwaysEmitIntoClient relates to library evolution. #38814

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 1, 2021
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 9 additions & 8 deletions docs/LibraryEvolution.rst
Original file line number Diff line number Diff line change
Expand Up @@ -269,15 +269,16 @@ Always Emit Into Client
A function, computed property or subscript annotated as ``@_alwaysEmitIntoClient``
is similar to an ``@inlinable`` declaration, except the declaration is
not part of the module's ABI, meaning that the client must always emit
their own copy.
their own copy. As a result:

As a result, removing a declaration annotated as ``@_alwaysEmitIntoClient``
is a binary-compatible source-breaking change.

.. admonition:: TODO

The implementation of ``@_alwaysEmitIntoClient`` is incomplete and
should probably graduate to having its own evolution proposal.
- Removing a declaration annotated as ``@_alwaysEmitIntoClient`` is a
`binary-compatible source-breaking change`.
- Adding ``@_alwaysEmitIntoClient`` to a declaration breaks ABI but is a
source-compatible change.
- Removing ``@_alwaysEmitIntoClient`` from a declaration is a
binary-compatible change. It also requires updating the availability
to at least the OS version where the attribute was removed. As a result,
it may be a source-breaking change.

Default Argument Expressions
----------------------------
Expand Down