50 |
Information Options
51 |
53 |
Print help message.
54 |
56 |
Print version information.
57 |
59 |
Print the tool version and don't do anything else.
60 |
General Options
61 |
- -l|-lib|-library NAME
62 |
63 |
Library name (without version). It affects only on the path and the title of the report.
64 |
66 |
Path to the Java ARchive or
XML-descriptor of 1st (old) library version.
67 |
69 |
Path to the Java ARchive or
XML-descriptor of 2nd (new) library version.
70 |
71 |
73 |
This option allows to specify the client Java ARchive that should be checked for portability to the newer library version.
74 |
76 |
Show "Binary" compatibility problems only. Generate report to "bin_compat_report.html" file.
77 |
79 |
Show "Source" compatibility problems only. Generate report to "src_compat_report.html" file.
80 |
- -check-implementation
81 |
82 |
Compare implementation code (method's body) of Java classes. Add "Changes in Implementation" section to the report.
83 |
85 |
Specify 1st library version outside the descriptor.
86 |
88 |
Specify 2nd library version outside the descriptor.
89 |
91 |
Treat all compatibility warnings as problems.
92 |
94 |
Do not skip checking of these packages: *impl*, *internal*, *examples*, *com.oracle*, *com.sun*, *COM.rsa*, *sun*, *sunw*
95 |
- -skip-internal PATTERN
96 |
97 |
Do not check internal packages matched by the pattern.
98 |
- -dump|-dump-api PATH
99 |
100 |
Create library API dump for the input descriptor. You can transfer it anywhere and pass instead of the descriptor. Also it may be used for debugging the tool.
101 |
103 |
This option allows to specify a file with a list of classes that should be checked, other classes will not be checked.
104 |
106 |
Skip analysis of deprecated methods and classes.
107 |
109 |
This option allows to specify a file with a list of classes that should not be checked.
110 |
112 |
Create XML descriptor template ./VERSION.xml
113 |
115 |
Path to compatibility report. Default: compat_reports/LIB_NAME/V1_to_V2/compat_report.html
116 |
- -bin-report-path PATH
117 |
118 |
Path to "Binary" compatibility report. Default: compat_reports/LIB_NAME/V1_to_V2/bin_compat_report.html
119 |
- -src-report-path PATH
120 |
121 |
Path to "Source" compatibility report. Default: compat_reports/LIB_NAME/V1_to_V2/src_compat_report.html
122 |
124 |
Quick analysis. Disabled: 1) analysis of method parameter names, 2) analysis of class field values, 3) analysis of usage of added abstract methods.
125 |
127 |
Enable sorting of data in API dumps.
128 |
130 |
Show access level of non-public methods listed in the report.
131 |
- -limit-affected LIMIT
132 |
133 |
The maximum number of affected methods listed under the description of the changed type in the report.
134 |
Other Options
135 |
137 |
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.
138 |
140 |
Debugging mode. Print debug info on the screen. Save intermediate analysis stages in the debug directory: debug/LIB_NAME/VER/. Also consider using --dump option for debugging the tool.
141 |
- -l-full|-lib-full NAME
142 |
143 |
Change library name in the report title to NAME. By default will be displayed a name specified by -l option.
144 |
146 |
Open report(s) in the browser (firefox, opera, etc.).
147 |
149 |
Open report(s) in the default browser.
150 |
152 |
Path to the JDK install tree (e.g. /usr/lib/jvm/java-7-openjdk-amd64).
153 |
154 |
161 |
162 |
163 |