Add documentation about the purpose of #apex and #symbols in map.txt

Currently we document the semantics of these two symbols. I would like
to add some documentation about why this granularity is necessary. The
majority of the details are contained in b/191371676

Test: N/A (documentation change)
Bug: 265485106
Change-Id: I752c921eabceff94f92f24a46c9a16dc28a2af19
This commit is contained in:
Spandan Das 2023-01-18 23:54:13 +00:00
parent 94682b23c4
commit 934c97da5e

View file

@ -1250,6 +1250,10 @@ func (library *libraryDecorator) compile(ctx ModuleContext, flags Flags, deps Pa
// b/239274367 --apex and --systemapi filters symbols tagged with # apex and # // b/239274367 --apex and --systemapi filters symbols tagged with # apex and #
// systemapi, respectively. The former is for symbols defined in platform libraries // systemapi, respectively. The former is for symbols defined in platform libraries
// and the latter is for symbols defined in APEXes. // and the latter is for symbols defined in APEXes.
// A single library can contain either # apex or # systemapi, but not both.
// The stub generator (ndkstubgen) is additive, so passing _both_ of these to it should be a no-op.
// However, having this distinction helps guard accidental
// promotion or demotion of API and also helps the API review process b/191371676
var flag string var flag string
if ctx.Module().(android.ApexModule).NotInPlatform() { if ctx.Module().(android.ApexModule).NotInPlatform() {
flag = "--apex" flag = "--apex"