You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
364 lines
11 KiB
364 lines
11 KiB
<!-- Creator : groff version 1.19.2 -->
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
|
|
"http://www.w3.org/TR/html4/loose.dtd">
|
|
<html>
|
|
<head>
|
|
<meta name="generator" content="groff -Thtml, see www.gnu.org">
|
|
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
|
|
<meta name="Content-Style" content="text/css">
|
|
<style type="text/css">
|
|
p { margin-top: 0; margin-bottom: 0; }
|
|
pre { margin-top: 0; margin-bottom: 0; }
|
|
table { margin-top: 0; margin-bottom: 0; }
|
|
</style>
|
|
<title>infer-run</title>
|
|
|
|
</head>
|
|
<body>
|
|
|
|
<h1 align=center>infer-run</h1>
|
|
|
|
<a href="#NAME">NAME</a><br>
|
|
<a href="#SYNOPSIS">SYNOPSIS</a><br>
|
|
<a href="#DESCRIPTION">DESCRIPTION</a><br>
|
|
<a href="#OPTIONS">OPTIONS</a><br>
|
|
<a href="#BUCK OPTIONS">BUCK OPTIONS</a><br>
|
|
<a href="#JAVA OPTIONS">JAVA OPTIONS</a><br>
|
|
<a href="#ENVIRONMENT">ENVIRONMENT</a><br>
|
|
<a href="#FILES">FILES</a><br>
|
|
<a href="#SEE ALSO">SEE ALSO</a><br>
|
|
|
|
<hr>
|
|
|
|
|
|
<a name="NAME"></a>
|
|
<h2>NAME</h2>
|
|
|
|
|
|
<p style="margin-left:11%; margin-top: 1em">infer-run -
|
|
capture source files, analyze, and report</p>
|
|
|
|
<a name="SYNOPSIS"></a>
|
|
<h2>SYNOPSIS</h2>
|
|
|
|
|
|
<p style="margin-left:11%; margin-top: 1em"><b>infer
|
|
run</b> <i>[options]</i> <b><br>
|
|
infer</b> <i>[options]</i> <b>--</b> <i>compile
|
|
command</i></p>
|
|
|
|
<a name="DESCRIPTION"></a>
|
|
<h2>DESCRIPTION</h2>
|
|
|
|
|
|
<p style="margin-left:11%; margin-top: 1em">Calling
|
|
"<b>infer run</b> <i>[options]</i>" is equivalent
|
|
to performing the following sequence of commands:</p>
|
|
|
|
<p style="margin-left:11%; margin-top: 1em"><b>infer
|
|
capture</b> <i>[options]</i> <b><br>
|
|
infer analyze</b> <i>[options]</i></p>
|
|
|
|
<a name="OPTIONS"></a>
|
|
<h2>OPTIONS</h2>
|
|
|
|
|
|
|
|
<p style="margin-left:11%; margin-top: 1em"><b>--censor-report</b>
|
|
<i>+string</i></p>
|
|
|
|
<p style="margin-left:17%;">Specify a filter for issues to
|
|
be censored by adding a 'censored_reason' field in the json
|
|
report. Infer will not report censored issues on the console
|
|
output and in report.txt, but tools that post-process the
|
|
json report can take them into account. If multiple filters
|
|
are specified, they are applied in the order in which they
|
|
are specified. Each filter is applied to each issue
|
|
detected, and only issues which are accepted by all filters
|
|
are reported. Each filter is of the form:
|
|
‘<issue_type_regex>:<filename_regex>:<reason_string>‘.
|
|
The first two components are OCaml Str regular expressions,
|
|
with an optional ‘!‘ character prefix. If a
|
|
regex has a ‘!‘ prefix, the polarity is
|
|
inverted, and the filter becomes a "blacklist"
|
|
instead of a "whitelist". Each filter is
|
|
interpreted as an implication: an issue matches if it does
|
|
not match the ‘issue_type_regex‘ or if it does
|
|
match the ‘filename_regex‘. The filenames that
|
|
are tested by the regex are relative to the
|
|
‘--project-root‘ directory. The
|
|
‘<reason_string>‘ is a non-empty string
|
|
used to explain why the issue was filtered.</p>
|
|
|
|
<p style="margin-left:11%;"><b>--debug</b>,<b>-g</b></p>
|
|
|
|
<p style="margin-left:17%;">Activates: Debug mode (also
|
|
sets <b>--debug-level 2</b>, <b>--developer-mode</b>,
|
|
<b>--print-buckets</b>, <b>--print-types</b>,
|
|
<b>--reports-include-ml-loc</b>,
|
|
<b>--no-only-cheap-debug</b>, <b>--trace-error</b>,
|
|
<b>--write-html</b>) (Conversely: <b>--no-debug</b> |
|
|
<b>-G</b>)</p>
|
|
|
|
<p style="margin-left:11%;"><b>--debug-level</b>
|
|
<i>level</i></p>
|
|
|
|
<p style="margin-left:17%;">Debug level (sets
|
|
<b>--bo-debug</b> <i>level</i>,
|
|
<b>--debug-level-analysis</b> <i>level</i>,
|
|
<b>--debug-level-capture</b> <i>level</i>,
|
|
<b>--debug-level-linters</b> <i>level</i>):</p>
|
|
|
|
<p style="margin-left:11%;">- 0: only basic debugging
|
|
enabled <br>
|
|
- 1: verbose debugging enabled <br>
|
|
- 2: very verbose debugging enabled <b><br>
|
|
--debug-level-analysis</b> <i>int</i></p>
|
|
|
|
<p style="margin-left:17%;">Debug level for the analysis.
|
|
See <b>--debug-level</b> for accepted values.</p>
|
|
|
|
<p style="margin-left:11%;"><b>--debug-level-capture</b>
|
|
<i>int</i></p>
|
|
|
|
<p style="margin-left:17%;">Debug level for the capture.
|
|
See <b>--debug-level</b> for accepted values.</p>
|
|
|
|
<p style="margin-left:11%;"><b>--debug-level-linters</b>
|
|
<i>int</i></p>
|
|
|
|
<p style="margin-left:17%;">Debug level for the linters.
|
|
See <b>--debug-level</b> for accepted values.</p>
|
|
|
|
<p style="margin-left:11%;"><b>--fail-on-issue</b></p>
|
|
|
|
<p style="margin-left:17%;">Activates: Exit with error code
|
|
2 if Infer found something to report (Conversely:
|
|
<b>--no-fail-on-issue</b>)</p>
|
|
|
|
|
|
<p style="margin-left:11%;"><b>--force-delete-results-dir</b></p>
|
|
|
|
<p style="margin-left:17%;">Activates: Do not refuse to
|
|
delete the results directory if it doesn't look like an
|
|
infer results directory. (Conversely:
|
|
<b>--no-force-delete-results-dir</b>)</p>
|
|
|
|
<p style="margin-left:11%;"><b>--force-integration</b>
|
|
<i>command</i></p>
|
|
|
|
<p style="margin-left:17%;">Proceed as if the first
|
|
argument after <b>--</b> was <i>command</i>. Possible
|
|
values: <i>ant</i>, <i>buck</i>, <i>gradle</i>,
|
|
<i>gradlew</i>, <i>java</i>, <i>javac</i>, <i>cc</i>,
|
|
<i>clang</i>, <i>gcc</i>, <i>clang++</i>, <i>c++</i>,
|
|
<i>g++</i>, <i>make</i>, <i>configure</i>, <i>cmake</i>,
|
|
<i>waf</i>, <i>mvn</i>, <i>mvnw</i>, <i>ndk-build</i>,
|
|
<i>rebar3</i>, <i>xcodebuild</i>.</p>
|
|
|
|
<p style="margin-left:11%;"><b>--help</b></p>
|
|
|
|
<p style="margin-left:17%;">Show this manual</p>
|
|
|
|
<p style="margin-left:11%;"><b>--help-format</b> <i>{ auto
|
|
| groff | pager | plain }</i></p>
|
|
|
|
<p style="margin-left:17%;">Show this help in the specified
|
|
format. <b>auto</b> sets the format to <b>plain</b> if the
|
|
environment variable <b>TERM</b> is "dumb" or
|
|
undefined, and to <b>pager</b> otherwise.</p>
|
|
|
|
<p style="margin-left:11%;"><b>--help-full</b></p>
|
|
|
|
<p style="margin-left:17%;">Show this manual with all
|
|
internal options in the INTERNAL OPTIONS section</p>
|
|
|
|
<p style="margin-left:11%;"><b>--pmd-xml</b></p>
|
|
|
|
<p style="margin-left:17%;">Activates: Output issues in
|
|
(PMD) XML format in infer-out/report.xml (Conversely:
|
|
<b>--no-pmd-xml</b>)</p>
|
|
|
|
<p style="margin-left:11%;"><b>--print-logs</b></p>
|
|
|
|
<p style="margin-left:17%;">Activates: Also log messages to
|
|
stdout and stderr (Conversely: <b>--no-print-logs</b>)</p>
|
|
|
|
|
|
<p style="margin-left:11%;"><b>--no-progress-bar</b>,<b>-P</b></p>
|
|
|
|
<p style="margin-left:17%;">Deactivates: Show a progress
|
|
bar (Conversely: <b>--progress-bar</b> | <b>-p</b>)</p>
|
|
|
|
|
|
<p style="margin-left:11%;"><b>--project-root</b>,<b>-C</b>
|
|
<i>dir</i></p>
|
|
|
|
<p style="margin-left:17%;">Specify the root directory of
|
|
the project</p>
|
|
|
|
<p style="margin-left:11%;"><b>--no-report</b></p>
|
|
|
|
<p style="margin-left:17%;">Deactivates: Run the reporting
|
|
phase once the analysis has completed (Conversely:
|
|
<b>--report</b>)</p>
|
|
|
|
|
|
<p style="margin-left:11%;"><b>--report-blacklist-files-containing</b>
|
|
<i>+string</i></p>
|
|
|
|
<p style="margin-left:17%;">Do not report any issues on
|
|
files containing the specified string</p>
|
|
|
|
|
|
<p style="margin-left:11%;"><b>--report-blacklist-path-regex</b>
|
|
<i>+path_regex</i></p>
|
|
|
|
<p style="margin-left:17%;">Do not report any issues on
|
|
files whose relative path matches the specified OCaml regex,
|
|
even if they match the whitelist specified by
|
|
<b>--report-whitelist-path-regex</b></p>
|
|
|
|
|
|
<p style="margin-left:11%;"><b>--report-force-relative-path</b></p>
|
|
|
|
<p style="margin-left:17%;">Activates: Force converting an
|
|
absolute path to a relative path to the root directory
|
|
(Conversely: <b>--no-report-force-relative-path</b>)</p>
|
|
|
|
|
|
<p style="margin-left:11%;"><b>--report-suppress-errors</b>
|
|
<i>+error_name</i></p>
|
|
|
|
<p style="margin-left:17%;">do not report a type of
|
|
errors</p>
|
|
|
|
|
|
<p style="margin-left:11%;"><b>--report-whitelist-path-regex</b>
|
|
<i>+path_regex</i></p>
|
|
|
|
<p style="margin-left:17%;">Report issues only on files
|
|
whose relative path matches the specified OCaml regex (and
|
|
which do not match <b>--report-blacklist-path-regex</b>)</p>
|
|
|
|
<p style="margin-left:11%;"><b>--results-dir</b>,<b>-o</b>
|
|
<i>dir</i></p>
|
|
|
|
<p style="margin-left:17%;">Write results and internal
|
|
files in the specified directory</p>
|
|
|
|
<p style="margin-left:11%;"><b>--skip-analysis-in-path</b>
|
|
<i>+path_prefix_OCaml_regex</i></p>
|
|
|
|
<p style="margin-left:17%;">Ignore files whose path matches
|
|
the given prefix (can be specified multiple times)</p>
|
|
|
|
<p style="margin-left:11%;"><b>--sqlite-cache-size</b>
|
|
<i>int</i></p>
|
|
|
|
<p style="margin-left:17%;">SQLite cache size in pages (if
|
|
positive) or kB (if negative), follows formal of
|
|
corresponding SQLite PRAGMA.</p>
|
|
|
|
<p style="margin-left:11%;"><b>--sqlite-lock-timeout</b>
|
|
<i>int</i></p>
|
|
|
|
<p style="margin-left:17%;">Timeout for SQLite results
|
|
database operations, in milliseconds.</p>
|
|
|
|
<p style="margin-left:11%;"><b>--sqlite-page-size</b>
|
|
<i>int</i></p>
|
|
|
|
<p style="margin-left:17%;">SQLite page size in bytes, must
|
|
be a power of two between 512 and 65536.</p>
|
|
|
|
<p style="margin-left:11%;"><b>--version</b></p>
|
|
|
|
<p style="margin-left:17%;">Print version information and
|
|
exit</p>
|
|
|
|
<p style="margin-left:11%;"><b>--version-json</b></p>
|
|
|
|
<p style="margin-left:17%;">Print version information in
|
|
json format and exit</p>
|
|
|
|
<table width="100%" border=0 rules="none" frame="void"
|
|
cellspacing="0" cellpadding="0">
|
|
<tr valign="top" align="left">
|
|
<td width="11%"></td>
|
|
<td width="3%">
|
|
|
|
|
|
<p style="margin-top: 1em" valign="top"><b>--</b></p></td>
|
|
<td width="3%"></td>
|
|
<td width="83%">
|
|
|
|
|
|
<p style="margin-top: 1em" valign="top">Stop argument
|
|
processing, use remaining arguments as a build command</p></td>
|
|
</table>
|
|
|
|
<a name="BUCK OPTIONS"></a>
|
|
<h2>BUCK OPTIONS</h2>
|
|
|
|
|
|
|
|
<p style="margin-left:11%; margin-top: 1em"><b>--buck-blacklist</b>
|
|
<i>+regex</i></p>
|
|
|
|
<p style="margin-left:17%;">Skip capture of files matched
|
|
by the specified regular expression. Only the clang,
|
|
non-compilation-database</p>
|
|
|
|
<p style="margin-left:11%;">Buck integration is supported,
|
|
not Java. <b><br>
|
|
--buck-targets-blacklist</b> <i>+regex</i></p>
|
|
|
|
<p style="margin-left:17%;">Skip capture of buck targets
|
|
matched by the specified regular expression. Only valid for
|
|
<b>--buck-compilation-database</b>.</p>
|
|
|
|
<a name="JAVA OPTIONS"></a>
|
|
<h2>JAVA OPTIONS</h2>
|
|
|
|
|
|
|
|
<p style="margin-left:11%; margin-top: 1em"><b>--capture-blacklist</b>
|
|
<i>regex</i></p>
|
|
|
|
<p style="margin-left:17%;">Skip capture of files matched
|
|
by the specified OCaml regular expression (only supported by
|
|
the javac integration for now).</p>
|
|
|
|
<a name="ENVIRONMENT"></a>
|
|
<h2>ENVIRONMENT</h2>
|
|
|
|
|
|
|
|
<p style="margin-left:11%; margin-top: 1em"><b>INFER_ARGS</b>,
|
|
<b>INFERCONFIG</b>, <b>INFER_STRICT_MODE</b></p>
|
|
|
|
<p style="margin-left:17%;">See the ENVIRONMENT section in
|
|
the manual of <b>infer</b>(1).</p>
|
|
|
|
<a name="FILES"></a>
|
|
<h2>FILES</h2>
|
|
|
|
|
|
|
|
<p style="margin-left:11%; margin-top: 1em"><b>.inferconfig</b></p>
|
|
|
|
<p style="margin-left:17%;">See the FILES section in the
|
|
manual of <b>infer</b>(1).</p>
|
|
|
|
<a name="SEE ALSO"></a>
|
|
<h2>SEE ALSO</h2>
|
|
|
|
|
|
|
|
<p style="margin-left:11%; margin-top: 1em"><b>infer-analyze</b>(1),
|
|
<b>infer-capture</b>(1), <b>infer-report</b>(1)</p>
|
|
<hr>
|
|
</body>
|
|
</html>
|