1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
|
<!DOCTYPE html>
<html lang="en" dir="ltr" class="client-nojs">
<head>
<title>Java API Compliance Checker Options</title>
<meta charset="UTF-8" />
<meta name="generator" content="MediaWiki 1.18.1" />
<link rel="shortcut icon" href="/favicon.ico" />
<link rel="search" type="application/opensearchdescription+xml" href="/opensearch_desc.php" title="ISP_RAS (en)" />
<link rel="EditURI" type="application/rsd+xml" href="http://ispras.linuxbase.org/api.php?action=rsd" />
<link rel="alternate" type="application/atom+xml" title="ISP_RAS Atom feed" href="/index.php?title=Special:RecentChanges&feed=atom" />
<link rel="stylesheet" href="/load.php?debug=false&lang=en&modules=mediawiki.legacy.commonPrint%2Cshared%7Cskins.monobook&only=styles&skin=monobook&*" />
<!--[if lt IE 5.5000]><link rel="stylesheet" href="/skins/monobook/IE50Fixes.css?303" media="screen" /><![endif]-->
<!--[if IE 5.5000]><link rel="stylesheet" href="/skins/monobook/IE55Fixes.css?303" media="screen" /><![endif]-->
<!--[if IE 6]><link rel="stylesheet" href="/skins/monobook/IE60Fixes.css?303" media="screen" /><![endif]-->
<!--[if IE 7]><link rel="stylesheet" href="/skins/monobook/IE70Fixes.css?303" media="screen" /><![endif]--><meta name="ResourceLoaderDynamicStyles" content="" />
<link rel="stylesheet" href="/load.php?debug=false&lang=en&modules=site&only=styles&skin=monobook&*" />
<style>a:lang(ar),a:lang(ckb),a:lang(fa),a:lang(kk-arab),a:lang(mzn),a:lang(ps),a:lang(ur){text-decoration:none}a.new,#quickbar a.new{color:#ba0000}
/* cache key: rasispdb:resourceloader:filter:minify-css:4:c88e2bcd56513749bec09a7e29cb3ffa */
</style>
<script src="/load.php?debug=false&lang=en&modules=startup&only=scripts&skin=monobook&*"></script>
<script>if(window.mw){
mw.config.set({"wgCanonicalNamespace": "", "wgCanonicalSpecialPageName": false, "wgNamespaceNumber": 0, "wgPageName": "Java_API_Compliance_Checker_Options", "wgTitle": "Java API Compliance Checker Options", "wgCurRevisionId": 7949, "wgArticleId": 2600, "wgIsArticle": true, "wgAction": "view", "wgUserName": null, "wgUserGroups": ["*"], "wgCategories": ["Java API Compliance Checker"], "wgBreakFrames": false, "wgRestrictionEdit": [], "wgRestrictionMove": []});
}
</script><script>if(window.mw){
mw.loader.load(["mediawiki.page.startup"]);
}
</script>
</head>
<body class="mediawiki ltr sitedir-ltr ns-0 ns-subject page-Java_API_Compliance_Checker_Options action-view skin-monobook">
<div id="globalWrapper">
<div id="column-content"><div id="content">
<a id="top"></a>
<h1 id="firstHeading" class="firstHeading">Java API Compliance Checker Options</h1>
<div id="bodyContent">
<div id="siteSub"></div>
<div id="contentSub"></div>
<!-- start content -->
<div lang="en" dir="ltr" class="mw-content-ltr"><table id="toc" class="toc"><tr><td><div id="toctitle"><h2>Contents</h2></div>
<ul>
<li class="toclevel-1 tocsection-1"><a href="#Information_Options"><span class="tocnumber">1</span> <span class="toctext">Information Options</span></a></li>
<li class="toclevel-1 tocsection-2"><a href="#General_Options"><span class="tocnumber">2</span> <span class="toctext">General Options</span></a></li>
<li class="toclevel-1 tocsection-3"><a href="#Extra_Options"><span class="tocnumber">3</span> <span class="toctext">Extra Options</span></a></li>
<li class="toclevel-1 tocsection-4"><a href="#Other_Options"><span class="tocnumber">4</span> <span class="toctext">Other Options</span></a></li>
</ul>
</td></tr></table>
<h2> <span class="mw-headline" id="Information_Options"> Information Options </span></h2>
<ul><li><b>-h|-help</b>
</li></ul>
<div style="padding-left:40px;">Print help message.</div><br />
<ul><li><b>-v|-version</b>
</li></ul>
<div style="padding-left:40px;">Print version information.</div><br />
<ul><li><b>-dumpversion</b>
</li></ul>
<div style="padding-left:40px;">Print the tool version and don't do anything else.</div><br />
<h2> <span class="mw-headline" id="General_Options"> General Options </span></h2>
<ul><li><b>-l|-library <name></b>
</li></ul>
<div style="padding-left:40px;">Library name (without version). It affects only on the path and the title of the report.</div><br />
<ul><li><b>-d1|-old|-o <path></b>
</li></ul>
<div style="padding-left:40px;">Path to the Java ARchive or <a href="http://ispras.linuxbase.org/index.php/Java_Library_Descriptor" title="Java Library Descriptor">XML-descriptor</a> of 1st (old) library version.</div><br />
<ul><li><b>-d2|-new|-n <path></b>
</li></ul>
<div style="padding-left:40px;">Path to the Java ARchive or <a href="http://ispras.linuxbase.org/index.php/Java_Library_Descriptor" title="Java Library Descriptor">XML-descriptor</a> of 2nd (new) library version.</div><br />
<h2> <span class="mw-headline" id="Extra_Options"> Extra Options </span></h2>
<ul><li><b>-client|-app <path></b>
</li></ul>
<div style="padding-left:40px;">This option allows to specify the client Java ARchive that should be checked for portability to the newer library version.</div><br />
<ul><li><b>-binary</b>
</li></ul>
<div style="padding-left:40px;">Show "Binary" compatibility problems only. Generate report to "bin_compat_report.html" file.</div><br />
<ul><li><b>-source</b>
</li></ul>
<div style="padding-left:40px;">Show "Source" compatibility problems only. Generate report to "src_compat_report.html" file.</div><br />
<ul><li><b>-check-implementation</b>
</li></ul>
<div style="padding-left:40px;">Compare implementation code (method's body) of Java classes. Add "Changes in Implementation" section to the report.</div><br />
<ul><li><b>-v1|-version1 <num></b>
</li></ul>
<div style="padding-left:40px;">Specify 1st library version outside the descriptor.</div><br />
<ul><li><b>-v2|-version2 <num></b>
</li></ul>
<div style="padding-left:40px;">Specify 2nd library version outside the descriptor.</div><br />
<ul><li><b>-s|-strict</b>
</li></ul>
<div style="padding-left:40px;">Treat all compatibility warnings as problems.</div><br />
<ul><li><b>-dump|-dump-api <descriptor></b>
</li></ul>
<div style="padding-left:40px;">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.</div><br />
<ul><li><b>-classes-list <path></b>
</li></ul>
<div style="padding-left:40px;">This option allows to specify a file with a list of classes that should be checked, other classes will not be checked.</div><br />
<ul><li><b>-d|-template</b>
</li></ul>
<div style="padding-left:40px;">Create XML descriptor template ./VERSION.xml</div><br />
<ul><li><b>-report-path <path></b>
</li></ul>
<div style="padding-left:40px;">Path to compatibility report. Default: compat_reports/<library name>/<v1>_to_<v2>/compat_report.html</div><br />
<ul><li><b>-bin-report-path <path></b>
</li></ul>
<div style="padding-left:40px;">Path to "Binary" compatibility report. Default: compat_reports/<library name>/<v1>_to_<v2>/bin_compat_report.html</div><br />
<ul><li><b>-src-report-path <path></b>
</li></ul>
<div style="padding-left:40px;">Path to "Source" compatibility report. Default: compat_reports/<library name>/<v1>_to_<v2>/src_compat_report.html</div><br />
<ul><li><b>-quick</b>
</li></ul>
<div style="padding-left:40px;">Quick analysis. Disabled: 1) analysis of method parameter names, 2) analysis of class field values, 3) analysis of usage of added abstract methods.</div><br />
<ul><li><b>-sort</b>
</li></ul>
<div style="padding-left:40px;">Enable sorting of data in API dumps.</div><br />
<h2> <span class="mw-headline" id="Other_Options"> Other Options </span></h2>
<ul><li><b>-test</b>
</li></ul>
<div style="padding-left:40px;">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.</div><br />
<ul><li><b>-debug</b>
</li></ul>
<div style="padding-left:40px;">Debugging mode. Print debug info on the screen. Save intermediate analysis stages in the debug directory: debug/<library>/<version>/. Also consider using --dump option for debugging the tool.</div><br />
<ul><li><b>-l-full|-lib-full <name></b>
</li></ul>
<div style="padding-left:40px;">Change library name in the report title to <name>. By default will be displayed a name specified by -l option.</div><br />
<ul><li><b>-b|-browse <program></b>
</li></ul>
<div style="padding-left:40px;">Open report(s) in the browser (firefox, opera, etc.).</div><br />
<ul><li><b>-open</b>
</li></ul>
<div style="padding-left:40px;">Open report(s) in the default browser.</div><br />
<!--
NewPP limit report
Preprocessor node count: 40/1000000
Post-expand include size: 0/2097152 bytes
Template argument size: 0/2097152 bytes
Expensive parser function count: 0/100
-->
<!-- Saved in parser cache with key rasispdb:pcache:idhash:2600-0!*!0!!en!*!* and timestamp 20120608135231 -->
</div></div></div></div></div></body></html>
|
