1NAME:
2  ABI Dumper — a tool to dump ABI of an ELF object containing DWARF debug info.
3
4  The tool is intended to be used with ABI Compliance Checker tool for tracking
5  ABI changes of a C/C++ library or kernel module.
6
7  The tool is developed by Andrey Ponomarenko: http://abi-laboratory.pro/
8
9INSTALL:
10  sudo make install prefix=/usr
11
12REQUIRES:
13  Perl 5 (5.8 or newer)
14  Elfutils (eu-readelf)
15  Vtable Dumper (1.0 or newer, https://github.com/lvc/vtable-dumper)
16  Universal Ctags
17
18USAGE:
19  abi-dumper libTest.so -o ABI.dump
20  abi-dumper Module.ko.debug
21
22EXAMPLES:
23  abi-dumper lib/libssh.so.3
24  abi-dumper drm/nouveau/nouveau.ko.debug
25
26NOTE:
27  Input objects should be compiled with -g -Og additional options to contain DWARF debug info.
28
29FILTER PUBLIC ABI:
30  abi-dumper libTest.so -public-headers PATH
31  PATH — path to the install tree of a library
32
33ABI CHECK:
34  abi-dumper libTest.so.0 -o ABIv0.dump
35  abi-dumper libTest.so.1 -o ABIv1.dump
36  abi-compliance-checker -l libTest -old ABIv0.dump -new ABIv1.dump
37
38COMPATIBILITY:
39  ABI Compliance Checker >= 1.99.24 (https://github.com/lvc/abi-compliance-checker)
40
41ADV. USAGE:
42  For advanced usage, see output of --help option.
43