README

NAME:
  ABI Dumper — a tool to dump ABI of an ELF object containing DWARF debug info.
  
  The tool is intended to be used with ABI Compliance Checker tool for tracking
  ABI changes of a C/C++ library or kernel module.
  
  The tool is developed by Andrey Ponomarenko: http://abi-laboratory.pro/

INSTALL:
  sudo make install prefix=/usr

REQUIRES:
  Perl 5 (5.8 or newer)
  Elfutils (eu-readelf)
  Vtable Dumper (1.0 or newer, https://github.com/lvc/vtable-dumper)
  Universal Ctags

USAGE:
  abi-dumper libTest.so -o ABI.dump
  abi-dumper Module.ko.debug

EXAMPLES:
  abi-dumper lib/libssh.so.3
  abi-dumper drm/nouveau/nouveau.ko.debug

NOTE:
  Input objects should be compiled with -g -Og additional options to contain DWARF debug info.

FILTER PUBLIC ABI:
  abi-dumper libTest.so -public-headers PATH
  PATH — path to the install tree of a library

ABI CHECK:
  abi-dumper libTest.so.0 -o ABIv0.dump
  abi-dumper libTest.so.1 -o ABIv1.dump
  abi-compliance-checker -l libTest -old ABIv0.dump -new ABIv1.dump

COMPATIBILITY:
  ABI Compliance Checker >= 1.99.24 (https://github.com/lvc/abi-compliance-checker)

ADV. USAGE:
  For advanced usage, see output of --help option.