A tool for checking backward API/ABI compatibility of a Java library
Perl Perl 6 Roff CSS Other
Latest commit a2d608d Aug 31, 2017 @lvc lvc Fixed version in README.

README

JAPICC 2.3
==========

NAME:
  Java API Compliance Checker (JAPICC) - a tool for checking backward binary and source-level compatibility of a Java library API.
  
  The tool checks classes declarations of old and new versions and analyzes changes that may break compatibility: removed methods, removed class fields, added abstract methods, etc. The tool is intended for developers of software libraries and Linux maintainers who are interested in ensuring backward compatibility.
  
  The Scala language is supported since 1.7 version of the tool.
  
  The tool is developed by Andrey Ponomarenko: https://abi-laboratory.pro/
  
  The tool is a core of the Java API Tracker project: https://abi-laboratory.pro/java/tracker/

INSTALL:
  sudo make install prefix=/usr

REQUIRES:
  JDK or OpenJDK - development files
  Perl 5

USAGE:
  japi-compliance-checker OLD.jar NEW.jar

API DUMPS:
  japi-compliance-checker -dump LIB.jar -dump-path ./API.dump
  japi-compliance-checker API-0.dump API-1.dump

ADV. USAGE:
  For advanced usage, see doc/index.html or output of --help option.

TEST SUITE:
  The tool is tested properly in the Java API Tracker project,
  by the community and by the internal test suite:
  
    japi-compliance-checker -test

  There are about 100 basic tests in the test suite.