desprezj / abi-compliance-checker

A tool for checking backward compatibility of a C/C++ library

NAME:
  ABI Compliance Checker (ACC) - a tool for checking backward binary and source-level compatibility of a shared C/C++ library API.

INSTALL:
  sudo perl Makefile.pl -install --prefix=/usr

USAGE:
  abi-compliance-checker -lib NAME -old OLD.xml -new NEW.xml

  OLD.xml and NEW.xml are XML-descriptors:

    <version>
        1.0
    </version>

    <headers>
        /path/to/headers/
    </headers>

    <libs>
        /path/to/libraries/
    </libs>

ADV. USAGE:
  For advanced usage, see doc/Readme.html or output of --help option.
  
COMPATIBILITY:
  ABI Dumper >= 0.98 (https://github.com/lvc/abi-dumper)
  
USAGE WITH ABI DUMPER:

   1. Library should be compiled with -g
      option to contain DWARF debug info
      
   2. Create ABI dumps for both library versions
      using the ABI Dumper (https://github.com/lvc/abi-dumper) tool:
      
        abi-dumper OLD.so -o ABI-0.dump -lver 0
        abi-dumper NEW.so -o ABI-1.dump -lver 1
        
   3. Compare ABI dumps:
   
        abi-compliance-checker -l NAME -old ABI-0.dump -new ABI-1.dump