api-sanity-checker 1.98.6-1 / usr / share / doc / api-sanity-checker / Options.html

This file is indexed.

/usr/share/doc/api-sanity-checker/Options.html is in api-sanity-checker 1.98.6-1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  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
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
<!DOCTYPE html>
<html lang="en" dir="ltr" class="client-nojs">
<head>
<title>API Sanity 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&amp;feed=atom" />
<link rel="stylesheet" href="/load.php?debug=false&amp;lang=en&amp;modules=mediawiki.legacy.commonPrint%2Cshared%7Cskins.monobook&amp;only=styles&amp;skin=monobook&amp;*" />
<!--[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&amp;lang=en&amp;modules=site&amp;only=styles&amp;skin=monobook&amp;*" />
<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&amp;lang=en&amp;modules=startup&amp;only=scripts&amp;skin=monobook&amp;*"></script>
<script>if(window.mw){
	mw.config.set({"wgCanonicalNamespace": "", "wgCanonicalSpecialPageName": false, "wgNamespaceNumber": 0, "wgPageName": "API_Sanity_Checker_Options", "wgTitle": "API Sanity Checker Options", "wgCurRevisionId": 8250, "wgArticleId": 2419, "wgIsArticle": true, "wgAction": "view", "wgUserName": null, "wgUserGroups": ["*"], "wgCategories": ["API Sanity 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-API_Sanity_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">API Sanity 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 this help.</div><br />
<ul><li><b>-info</b>
</li></ul>
<div style="padding-left:40px;">Print complete information.</div><br />
<ul><li><b>-v|-version</b>
</li></ul>
<div style="padding-left:40px;">Print version.</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|-lib|-library NAME</b>
</li></ul>
<div style="padding-left:40px;">Library name (without version).</div><br />
<ul><li><b>-d|-descriptor PATH</b>
</li></ul>
<div style="padding-left:40px;">Path to the <a href="Descriptor.html" title="Library Descriptor">library descriptor</a>.</div><br />
<ul><li><b>-gen|-generate</b>
</li></ul>
<div style="padding-left:40px;">Generate test(s). Options -l and -d should be specified. To generate test for the particular function use it with -f option.</div><br />
<ul><li><b>-build|-make</b>
</li></ul>
<div style="padding-left:40px;">Build test(s). Options -l and -d should be specified. To build test for the particular function use it with -f option.</div><br />
<ul><li><b>-run</b>
</li></ul>
<div style="padding-left:40px;">Run test(s), create test report. Options -l and -d should be specified. To run test for the particular function use it with -f option.</div><br />
<ul><li><b>-clean</b>
</li></ul>
<div style="padding-left:40px;">Clean test(s). Options -l and -d should be specified. To clean test for the particular function use it with -f option.</div><br />
<h2> <span class="mw-headline" id="Extra_Options"> Extra Options </span></h2>
<ul><li><b>-d-tmpl|-descriptor-template</b>
</li></ul>
<div style="padding-left:40px;">Create library descriptor template ./VERSION.xml</div><br />
<ul><li><b>-s-tmpl|-specialized-type-template</b>
</li></ul>
<div style="padding-left:40px;">Create specialized type template ./SPECTYPES.xml</div><br />
<ul><li><b>-vnum NUM</b>
</li></ul>
<div style="padding-left:40px;">Specify library version outside the descriptor.</div><br />
<ul><li><b>-s|-symbol NAME</b>
</li></ul>
<div style="padding-left:40px;">Generate/Build/Run test for specified interface (mangled name in C++).</div><br />
<ul><li><b>-symbols-list PATH</b>
</li></ul>
<div style="padding-left:40px;">This option allow to specify a file with a list of functions (one per line, mangled names in C++) that should be tested, other library interfaces will not be tested.</div><br />
<ul><li><b>-header NAME</b>
</li></ul>
<div style="padding-left:40px;">This option allows to restrict a list of functions that should be tested by providing a header file name in which they are declared. This option was introduced for step-by-step tests development.</div><br />
<ul><li><b>-xvfb</b>
</li></ul>
<div style="padding-left:40px;">Use Xvfb-server instead of current X-server (default) for running tests.</div><br />
<ul><li><b>-t2c|-template2code</b>
</li></ul>
<div style="padding-left:40px;">Generate tests in the universal <a rel="nofollow" class="external text" href="http://sourceforge.net/projects/template2code/">Template2Code</a> format.</div><br />
<ul><li><b>-strict-gen</b>
</li></ul>
<div style="padding-left:40px;">Terminate the process of generating tests if cannot generate at least one test case.</div><br />
<ul><li><b>-strict-build</b>
</li></ul>
<div style="padding-left:40px;">Terminate the process of building tests if cannot build at least one test case.</div><br />
<ul><li><b>-strict-run</b>
</li></ul>
<div style="padding-left:40px;">Terminate the process of running tests if at least one test case is failed.</div><br />
<ul><li><b>-strict</b>
</li></ul>
<div style="padding-left:40px;">This option enables all -strict-* options.</div><br />
<ul><li><b>-r|-random</b>
</li></ul>
<div style="padding-left:40px;">Random tests generating mode.</div><br />
<ul><li><b>-min</b>
</li></ul>
<div style="padding-left:40px;">Generate minimun code (as far as possible).</div><br />
<ul><li><b>-max</b>
</li></ul>
<div style="padding-left:40px;">Generate maximum code (as far as possible).</div><br />
<ul><li><b>-show-retval</b>
</li></ul>
<div style="padding-left:40px;">Show the function return type in the report.</div><br />
<ul><li><b>-check-retval</b>
</li></ul>
<div style="padding-left:40px;">Insert requirements on return values (retval!=NULL) for each called interface.</div><br />
<ul><li><b>-st|-specialized-types PATH</b>
</li></ul>
<div style="padding-left:40px;">Path to the collection of <a href="SpecType.html" title="Specialized Type">specialized types</a>.</div><br />
<ul><li><b>-td|-test-data PATH</b>
</li></ul>
<div style="padding-left:40px;">Path to the directory with <a href="http://ispras.linuxbase.org/index.php/Specialized_Type#Using_Test_Data" title="Specialized Type">test data</a>.</div><br />
<ul><li><b>-headers-only</b>
</li></ul>
<div style="padding-left:40px;">If the library consists of inline functions only and has no shared objects then you should specify this option.</div><br />
<ul><li><b>-no-inline</b>
</li></ul>
<div style="padding-left:40px;">Don't generate tests for inline functions.</div><br />
<ul><li><b>-keep-internal</b>
</li></ul>
<div style="padding-left:40px;">Generate tests for internal symbols (functions with '__' prefix and methods of classes declared inside other classes).</div><br />
<ul><li><b>-isolated</b>
</li></ul>
<div style="padding-left:40px;">Allow to restrict functions usage by the lists specified by the -functions-list option<br />or by the group devision in the descriptor.</div><br />
<ul><li><b>-view-only</b>
</li></ul>
<div style="padding-left:40px;">Remove all files from the test suite except *.html files. This option allows to create a lightweight html-index for all tests in the test suite.</div><br />
<ul><li><b>-disable-default-values</b>
</li></ul>
<div style="padding-left:40px;">Disable usage of default values for function parameters.</div><br />
<ul><li><b>-optimize-includes LEVEL</b>
</li></ul>
<div style="padding-left:40px;">Enable optimization of the list of included headers in each test case. Available levels: High (default), Medium, Low, None - disable.</div><br />
<ul><li><b>-p|-params PATH</b>
</li></ul>
<div style="padding-left:40px;">Path to file with the function parameter names. It can be used for improving generated tests if the library header files don't contain parameter names. File format:</div>
<div style="padding-left:80px;">func1;param1;param2;param3 ...<br />func2;param1;param2;param3 ...<br />...</div><br />
<ul><li><b>-l-full|-lib-full NAME</b>
</li></ul>
<div style="padding-left:40px;">Library name in the report title.</div><br />
<ul><li><b>-relpath|-reldir PATH</b>
</li></ul>
<div style="padding-left:40px;">Replace {RELPATH} in the library descriptor by PATH.</div><br />
<ul><li><b>-lang LANG</b>
</li></ul>
<div style="padding-left:40px;">Set library language (C or C++). You can use this option if the tool cannot auto-detect a language.</div><br />
<ul><li><b>-target COMPILER</b>
</li></ul>
<div style="padding-left:40px;">The compiler that should be used to build generated tests under Windows: gcc - GNU compiler, cl - MS compiler (default).</div><br />
<ul><li><b>-debug</b>
</li></ul>
<div style="padding-left:40px;">Write extended log for debugging.</div><br />
<ul><li><b>-cache</b>
</li></ul>
<div style="padding-left:40px;">Cache the ABI dump and use it on the next run.</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;">Run internal tests. Create a simple library and run the tool on it. This option allows to check if the tool works correctly on the system.</div><br />
<ul><li><b>-disable-variable-reuse</b>
</li></ul>
<div style="padding-left:40px;">Disable reusing of previously created variables.</div><br />
<ul><li><b>-long-variable-names</b>
</li></ul>
<div style="padding-left:40px;">Enable long (complex) variable names instead of short names (default).</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: 63/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:2419-0!*!0!!en!*!* and timestamp 20130916134526 -->
</div></div></div></div></div></body></html>

APT Browse - Built by Thomas Orozco.