Skip to content

Commit

Permalink
Update README.md to describe the IgnoreJDKClass option
Browse files Browse the repository at this point in the history
Signed-off-by: Scott Marlow <smarlow@redhat.com>
  • Loading branch information
scottmarlow committed Apr 13, 2021
1 parent a3bb665 commit 72e39bb
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Expand Up @@ -134,6 +134,14 @@ then try:

with the action option set to `strictcheck` the plugin will detect any API change and fail even if it is compatible.

## Relax verification of JDK signatures

There are some cases where avoiding the verification of certain JDK classes entirely or their signatures can improve the ability to verify your API on different JDK versions.
The `-IgnoreJDKClass` option can be used to specify a set of JDK classes that can benefit from relaxed signature verification rules when it comes to dealing with JDK
specific signature changes introduced by a later JDK version. As an example, a Signature file with @java.lang.Deprecated annotations from JDK8 may be seeing verification failures on JDK9+
due to `default` fields being added to @Deprecated. With `-IgnoreJDKClass java.lang.Deprecated` enabled, verification of the @Deprecated will only check that the tested class member has the
@Deprecated class but no verification of the @Deprecated signature will be performed.

## History

This tool is based on original [SigTest](https://wiki.openjdk.java.net/display/CodeTools/sigtest) sources,
Expand Down

0 comments on commit 72e39bb

Please sign in to comment.