.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.49.2.
.TH JAPI-COMPLIANCE-CHECKER "1" "November 2022" "Java API Compliance Checker (JAPICC) 2.4" "User Commands"
.SH NAME
japi-compliance-checker \- Check backward compatibility of a Java library API
.SH DESCRIPTION
.SS "NAME:"
.IP
Java API Compliance Checker (japi\-compliance\-checker)
Check backward compatibility of a Java library API
.SS "DESCRIPTION:"
.IP
Java API Compliance Checker (JAPICC) is a tool for checking backward
binary/source compatibility of a Java library API. The tool checks class
declarations of old and new versions and analyzes changes that may break
compatibility: removed class members, added abstract methods, etc.
.IP
Break of the binary compatibility may result in crash or incorrect behavior
of existing clients built with an old library version if they run with a
new one. Break of the source compatibility may result in recompilation
errors with a new library version.
.IP
The tool is intended for developers of software libraries and maintainers
of operating systems who are interested in ensuring backward compatibility,
i.e. allow old clients to run or to be recompiled with newer library
versions.
.IP
This tool is free software: you can redistribute it and/or modify it
under the terms of the GNU LGPL.
.SS "USAGE:"
.IP
japi\-compliance\-checker [options]
.SS "EXAMPLE (1):"
.IP
japi\-compliance\-checker OLD.jar NEW.jar
.SS "EXAMPLE (2):"
.IP
japi\-compliance\-checker OLD.jmod NEW.jmod
.SS "EXAMPLE (3):"
.IP
japi\-compliance\-checker \fB\-lib\fR NAME \fB\-old\fR OLD.xml \fB\-new\fR NEW.xml
OLD.xml and NEW.xml are XML\-descriptors:
.IP
<version>
.IP
1.0
.IP
</version>
.IP
<archives>
.IP
/path1/to/JAR(s) OR JMOD(s)/
/path2/to/JAR(s) OR JMOD(s)/
\&...
.IP
</archives>
.SS "INFORMATION OPTIONS:"
.HP
\fB\-h\fR|\-help
.IP
Print this help.
.HP
\fB\-v\fR|\-version
.IP
Print version information.
.HP
\fB\-dumpversion\fR
.IP
Print the tool version (2.4) and don't do anything else.
.SS "GENERAL OPTIONS:"
.HP
\fB\-l\fR|\-library NAME
.IP
Library name (without version).
.HP
\fB\-old\fR|\-d1 PATH
.IP
Descriptor of the 1st (old) library version.
It may be one of the following:
.IP
1. Java archive (*.jar or *.jmod)
2. XML\-descriptor (VERSION.xml file):
.IP
<version>
.IP
1.0
.IP
</version>
.IP
<archives>
.IP
/path1/to/JAR(s) OR JMOD(s)/
/path2/to/JAR(s) OR JMOD(s)/
.IP
\&...
.IP
</archives>
.IP
\&...
.IP
3. API dump generated by \fB\-dump\fR option
.IP
If you are using *.jar or *.jmod as a descriptor then
you should specify version numbers with \fB\-v1\fR and \fB\-v2\fR
options too. If version numbers are not specified then
the tool will try to detect them automatically.
.HP
\fB\-new\fR|\-d2 PATH
.IP
Descriptor of the 2nd (new) library version.
.SS "EXTRA OPTIONS:"
.HP
\fB\-client\fR|\-app PATH
.IP
This option allows to specify the client Java archive that should be
checked for portability to the new library version.
.HP
\fB\-binary\fR|\-bin
.IP
Show "Binary" compatibility problems only.
Generate report to "bin_compat_report.html".
.HP
\fB\-source\fR|\-src
.IP
Show "Source" compatibility problems only.
Generate report to "src_compat_report.html".
.HP
\fB\-v1\fR|\-version1 NUM
.IP
Specify 1st API version outside the descriptor. This option is needed
if you have prefered an alternative descriptor type (see \fB\-d1\fR option).
.IP
In general case you should specify it in the XML descriptor:
.IP
<version>
.IP
VERSION
.IP
</version>
.HP
\fB\-v2\fR|\-version2 NUM
.IP
Specify 2nd library version outside the descriptor.
.HP
\fB\-vnum\fR NUM
.IP
Specify the library version in the generated API dump.
.HP
\fB\-s\fR|\-strict
.IP
Treat all API compatibility warnings as problems.
.HP
\fB\-keep\-internal\fR
.IP
Do not skip checking of these packages:
.IP
*impl*
*internal*
*examples*
.HP
\fB\-skip\-internal\-packages\fR PATTERN
.IP
Do not check packages matched by the regular expression.
.HP
\fB\-skip\-internal\-types\fR PATTERN
.IP
Do not check types (classes and interfaces) matched by the regular
expression. It's matched against full qualified type names (e.g.
\&'org.xyz.Name<T>'). It has to match any part of type name.
.HP
\fB\-dump\fR|\-dump\-api PATH
.IP
Dump library API to gzipped TXT format file. You can transfer it
anywhere and pass instead of the descriptor. Also it may be used
for debugging the tool. PATH is the path to the Java archive or
XML descriptor of the library.
.HP
\fB\-check\-annotations\fR
.IP
Check for changes in annotations like in any other interfaces.
.HP
\fB\-check\-packages\fR PATTERN
.IP
Check packages matched by the regular expression. Other packages
will not be checked.
.HP
\fB\-classes\-list\fR PATH
.IP
This option allows to specify a file with a list
of classes that should be checked, other classes will not be checked.
.HP
\fB\-annotations\-list\fR PATH
.IP
Specifies a file with a list of annotations. The tool will check only
classes annotated by the annotations from the list. Other classes
will not be checked.
.HP
\fB\-skip\-annotations\-list\fR PATH
.IP
Skip checking of classes annotated by the annotations in the list.
.HP
\fB\-skip\-deprecated\fR
.IP
Skip analysis of deprecated methods and classes.
.HP
\fB\-skip\-classes\fR PATH
.IP
List of classes that should not be checked.
.HP
\fB\-skip\-packages\fR PATH
.IP
List of packages that should not be checked.
.HP
\fB\-non\-impl\fR PATH
.IP
List of interfaces that should not be implemented by users.
.HP
\fB\-non\-impl\-all\fR
.IP
All interfaces should not be implemented by users.
.HP
\fB\-short\fR
.IP
Do not list added/removed methods.
.HP
\fB\-dump\-path\fR PATH
.IP
Specify a *.dump file path where to generate an API dump.
Default:
.IP
api_dumps/LIB_NAME/VERSION/API.dump
.HP
\fB\-report\-path\fR PATH
.IP
Path to compatibility report.
Default:
.IP
compat_reports/LIB_NAME/V1_to_V2/compat_report.html
.HP
\fB\-bin\-report\-path\fR PATH
.IP
Path to "Binary" compatibility report.
Default:
.IP
compat_reports/LIB_NAME/V1_to_V2/bin_compat_report.html
.HP
\fB\-src\-report\-path\fR PATH
.IP
Path to "Source" compatibility report.
Default:
.IP
compat_reports/LIB_NAME/V1_to_V2/src_compat_report.html
.HP
\fB\-quick\fR
.IP
Quick analysis.
Disabled:
.IP
\- analysis of method parameter names
\- analysis of class field values
\- analysis of usage of added abstract methods
\- distinction of deprecated methods and classes
.HP
\fB\-sort\fR
.IP
Enable sorting of data in API dumps.
.HP
\fB\-show\-access\fR
.IP
Show access level of non\-public methods listed in the report.
.HP
\fB\-hide\-templates\fR
.IP
Hide template parameters in the report.
.HP
\fB\-hide\-packages\fR
.HP
\fB\-minimal\fR
.IP
Do nothing.
.HP
\fB\-show\-packages\fR
.IP
Show package names in the report.
.HP
\fB\-limit\-affected\fR LIMIT
.IP
The maximum number of affected methods listed under the description
of the changed type in the report.
.HP
\fB\-compact\fR
.IP
Try to simplify formatting and reduce size of the report (for a big
set of changes).
.HP
\fB\-added\-annotations\fR
.IP
Apply filters by annotations only to new version of the library.
.HP
\fB\-removed\-annotations\fR
.IP
Apply filters by annotations only to old version of the library.
.HP
\fB\-count\-methods\fR PATH
.IP
Count total public methods in the API dump.
.HP
\fB\-dep1\fR PATH
.HP
\fB\-dep2\fR PATH
.IP
Path to the API dump of the required dependency archive. It will
be used to resolve overwritten methods and more.
.HP
\fB\-old\-style\fR
.IP
Generate old\-style report.
.SS "OTHER OPTIONS:"
.HP
\fB\-test\fR
.IP
Run internal tests. Create two incompatible versions of a sample library
and run the tool to check them for compatibility. This option allows to
check if the tool works correctly in the current environment.
.HP
\fB\-debug\fR
.IP
Debugging mode. Print debug info on the screen. Save intermediate
analysis stages in the debug directory:
.IP
debug/LIB_NAME/VER/
.IP
Also consider using \fB\-dump\fR option for debugging the tool.
.HP
\fB\-title\fR NAME
.IP
Change library name in the report title to NAME. By default
will be displayed a name specified by \fB\-l\fR option.
.HP
\fB\-jdk\-path\fR PATH
.IP
Path to the JDK install tree (e.g. \fI\,/usr/lib/jvm/java\-7\-openjdk\-amd64\/\fP).
.HP
\fB\-external\-css\fR PATH
.IP
Generate CSS styles file to PATH. This helps to save space when
generating thousands of reports.
.HP
\fB\-external\-js\fR PATH
.IP
Generate JS script file to PATH.
.SS "REPORT:"
.IP
Compatibility report will be generated to:
.IP
compat_reports/LIB_NAME/V1_to_V2/compat_report.html
.SS "EXIT CODES:"
.IP
0 \- Compatible. The tool has run without any errors.
non\-zero \- Incompatible or the tool has run with errors.
.SS "MORE INFO:"
.IP
https://lvc.github.io/japi\-compliance\-checker/
https://github.com/lvc/japi\-compliance\-checker
.SH AUTHOR
Written by Andrey Ponomarenko.
.SH COPYRIGHT
Copyright \(co 2018 Andrey Ponomarenko's ABI Laboratory
License: LGPLv2.1+ <http://www.gnu.org/licenses/>
This program is free software: you can redistribute it and/or modify it.