LineageOS/android_development
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge "Update README in header checker for option ignored_linker_set_keys"

Browse Source
This commit is contained in:
Mu-Le Lee
2022-09-05 08:13:48 +00:00
committed by Gerrit Code Review
parent a008152637 173a9dd208
commit 3ccbbe8717
1 changed files with 19 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
vndk/tools/header-checker/README.md
View File

@@ -90,12 +90,21 @@ header-abi-diff applies cli flags first, then the global config section and
library config section. library config section.
#### Target version #### Target version
The Soong Build System performs Cross-Version ABI Check. For example, when the The Soong Build System performs Cross-Version ABI Check on NDK and platform
libraries to ensure their compatibility across versions. For example, when the
future SDK version of current source is 34, the source ABI dump would be diffed future SDK version of current source is 34, the source ABI dump would be diffed
with version 33 dump to check the backward compatibility. In this case, the with version 33 dump to check the backward compatibility. In this case, the
`-target-version 34` is passed to header-abi-diff to select the corresponding `-target-version 34` is passed to header-abi-diff to select the corresponding
config section. config section.
#### Linker Set Keys
In some cases, it is necessary to skip the ABI check for specific types and
functions. In the ABI dumps, every class, union, enum, and function has a
unique linker set key. The cli option `-ignore-linker-set-key` and the key
`ignore_linker_set_keys` in the config section specify the types and
functions that should be skipped. The linker set key can be found in the
generated .abidiff file and the .lsdump file.
#### Format #### Format
Here is an example of a config.json. Here is an example of a config.json.
```json ```json
@@ -114,6 +123,9 @@ Here is an example of a config.json.
}, },
{ {
"target_version": "34", "target_version": "34",
"ignore_linker_set_keys": [
"_ZTI14internal_state",
],
"flags": { "flags": {
"allow_extensions": true, "allow_extensions": true,
} }
@@ -123,14 +135,17 @@ Here is an example of a config.json.
``` ```
#### Library Config Section #### Library Config Section
A library config section includes two members: "target_version" and "flags". A library config section includes members: "target_version",
header-abi-diff selects the config section that matches the target version "ignore_linker_set_keys" and "flags". header-abi-diff selects the config
given by cli. section that matches the target version given by cli.
Take above config as an example, if `-target-version 34` and `-lib libfoo` are Take above config as an example, if `-target-version 34` and `-lib libfoo` are
specified, the selected config section is: specified, the selected config section is:
```json ```json
{ {
"target_version": "34", "target_version": "34",
"ignore_linker_set_keys": [
"_ZTI14internal_state",
],
"flags": { "flags": {
"allow_extensions": true, "allow_extensions": true,
} }