diff options
| author | Dan Albert <danalbert@google.com> | 2021-06-04 14:31:58 -0700 |
|---|---|---|
| committer | Dan Albert <danalbert@google.com> | 2021-06-10 16:38:19 -0700 |
| commit | 56f52de8bd246623a329cfc374baedba2611767f (patch) | |
| tree | 18ed388993d6a256b3859ccc6dca08bae421aa5a /docs | |
| parent | ead21552eef4d1d046693dbc39dd639a4e8f32b4 (diff) | |
Add systemapi as an APEX synonym for stub maps.
The apex tag is currently used for platform-to-APEX, APEX-to-APEX, and
APEX-to-platform, and it's difficult to tell when reviewing the map
files. Add a synonym so authors can be explicit about platform-to-APEX
since those have different stability rules.
Test: pytest
Test: mypy
Test: pylint
Test: treehugger
Bug: None
Change-Id: I0aee679a05b1b2d3749307434c19486bf4c7fe52
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/map_files.md | 14 |
1 files changed, 11 insertions, 3 deletions
diff --git a/docs/map_files.md b/docs/map_files.md index 192530fb6..13880591a 100644 --- a/docs/map_files.md +++ b/docs/map_files.md @@ -70,9 +70,11 @@ the same line. The supported tags are: ### apex -Indicates that the version or symbol is to be exposed in the APEX stubs rather -than the NDK. May be used in combination with `llndk` if the symbol is exposed -to both APEX and the LL-NDK. +Indicates that the version or symbol is to be exposed by an APEX rather than the +NDK. For APIs exposed by the platform *for* APEX, use `systemapi`. + +May be used in combination with `llndk` if the symbol is exposed to both APEX +and the LL-NDK. ### future @@ -144,6 +146,12 @@ for use by the NDK, LL-NDK, or APEX (similar to Java's `@SystemAPI`). It is preferable to keep such APIs in an entirely separate library to protect them 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. + ### var Used to define a public global variable. By default all symbols are exposed as |