xref: /third_party/libabigail/README (revision e01aa904)
1e01aa904Sopenharmony_ciThis is the Application Binary Interface Generic Analysis and
2e01aa904Sopenharmony_ciInstrumentation Library.
3e01aa904Sopenharmony_ci
4e01aa904Sopenharmony_ciIt aims at constructing, manipulating, serializing and de-serializing
5e01aa904Sopenharmony_ciABI-relevant artifacts.
6e01aa904Sopenharmony_ci
7e01aa904Sopenharmony_ciThe set of artifacts that we are intersted is made of quantities like
8e01aa904Sopenharmony_citypes, variable, functions and declarations of a given library or
9e01aa904Sopenharmony_ciprogram.  For a given library or program this set of quantities is
10e01aa904Sopenharmony_cicalled an ABI corpus.
11e01aa904Sopenharmony_ci
12e01aa904Sopenharmony_ciThis library aims at (among other things) providing a way to compare
13e01aa904Sopenharmony_citwo ABI Corpora (apparently the plural of corpus is copora, heh,
14e01aa904Sopenharmony_cithat's cool), provide detailed information about their differences,
15e01aa904Sopenharmony_ciand help build tools to infer interesting conclusions about these
16e01aa904Sopenharmony_cidifferences.
17e01aa904Sopenharmony_ci
18e01aa904Sopenharmony_ciYou are welcome to contribute to this project after reading the files
19e01aa904Sopenharmony_ciCONTRIBUTING and COMMIT-LOG-GUIDELINES files in the source tree.
20e01aa904Sopenharmony_ci
21e01aa904Sopenharmony_ciCommunicating with the maintainers of this project -- including
22e01aa904Sopenharmony_cisending patches to be include to the source code -- happens via email
23e01aa904Sopenharmony_ciat libabigail@sourceware.org.
24