Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 357ebe5e authored by Spandan Das's avatar Spandan Das Committed by Gerrit Code Review
Browse files

Merge "Doc updates for #apex and #systemapi"

parents 92b6e8ec 24df3c20
Loading
Loading
Loading
Loading
+18 −3
Original line number Diff line number Diff line
@@ -148,9 +148,24 @@ from access via `dlsym`, but this is not always possible.

### systemapi

This is a synonym of the `apex` tag. It should be used to clarify that the API
is an API exposed by the system for an APEX, whereas `apex` should be used for
APIs exposed by an APEX to the platform or another APEX.
Indicates that the symbol is exposed by the platform for an apex. Whereas `apex`
should be used for APIs exposed by an APEX to the platform or another APEX.

May be used in combination with `llndk` if the symbol is exposed to both APEX
and the LL-NDK.

Since a single library can be installed ether in platform or an apex, but not
both, a single map.txt file should not contain _both_ # apex and # systemapi symbols.

The granularity between # apex and # systemapi exists to help the API review
process (b/191371676). These two symbols have very similar lifetime "in
practice". A #systemapi symbol can be dropped from the next release if we are
confident that no one is using it. Similarily, #apex can be dropped if we are
sure that the old platform which used the symbol has reached EOL and thus is no
longer accepting new APEX updates. Unlike the APIs for apps where we have zero
control over how APIs are used, we are in a much more controllable environment
when talking about #systemapi and #apex symbols. So, we have some flexibility
here when determining the lifetime of a symbol.

### var