doc/manual/running.html - Issue 1232833004: Update findbugs from 3.0.0 to 3.0.1.

Unified Diff: doc/manual/running.html

Issue 1232833004: Update findbugs from 3.0.0 to 3.0.1. (Closed) Base URL: https://chromium.googlesource.com/chromium/deps/findbugs.git@master

Patch Set: Created 5 years, 5 months ago

Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.

Jump to:

View side-by-side diff with in-line comments

Download patch

Index: doc/manual/running.html

diff --git a/doc/manual/running.html b/doc/manual/running.html

index cf83c855aed611e7efd43b92479253052f8e5081..2510fe8d6129db045fb8b4d6852b6d388f086eb0 100644

--- a/doc/manual/running.html

+++ b/doc/manual/running.html

@@ -1,13 +1,13 @@

- <title>Chapter 4. Running FindBugs™</title><meta name="generator" content="DocBook XSL Stylesheets V1.76.1"><link rel="home" href="index.html" title="FindBugs™ Manual"><link rel="up" href="index.html" title="FindBugs™ Manual"><link rel="prev" href="building.html" title="Chapter 3. Building FindBugs™ from Source"><link rel="next" href="gui.html" title="Chapter 5. Using the FindBugs GUI"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Chapter 4. Running <span class="application">FindBugs</span>™</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="building.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="gui.html">Next</a></td></tr></table><hr></div><div class="chapter" title="Chapter 4. Running FindBugs™"><div class="titlepage"><div><div><h2 class="title"><a name="running"></a>Chapter 4. Running <span class="application">FindBugs</span>™</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a href="running.html#d0e465">1. Quick Start</a></span></dt><dt><span class="sect1"><a href="running.html#d0e503">2. Executing <span class="application">FindBugs</span></a></span></dt><dt><span class="sect1"><a href="running.html#commandLineOptions">3. Command-line Options</a></span></dt></dl></div><p>

+ <title>Chapter 4. Running FindBugs™</title><meta name="generator" content="DocBook XSL Stylesheets V1.78.1"><link rel="home" href="index.html" title="FindBugs™ Manual"><link rel="up" href="index.html" title="FindBugs™ Manual"><link rel="prev" href="building.html" title="Chapter 3. Building FindBugs™ from Source"><link rel="next" href="gui.html" title="Chapter 5. Using the FindBugs GUI"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Chapter 4. Running <span class="application">FindBugs</span>™</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="building.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="gui.html">Next</a></td></tr></table><hr></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a name="running"></a>Chapter 4. Running <span class="application">FindBugs</span>™</h1></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl class="toc"><dt><span class="sect1"><a href="running.html#d0e465">1. Quick Start</a></span></dt><dt><span class="sect1"><a href="running.html#d0e503">2. Executing <span class="application">FindBugs</span></a></span></dt><dt><span class="sect1"><a href="running.html#commandLineOptions">3. Command-line Options</a></span></dt></dl></div><p>

<span class="application">FindBugs</span> has two user interfaces: a graphical user interface (GUI) and a

command line user interface. This chapter describes

how to run each of these user interfaces.

-</p><div class="warning" title="Warning" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Warning"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Warning]" src="warning.png"></td><th align="left">Warning</th></tr><tr><td align="left" valign="top"><p>

+</p><div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Warning"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Warning]" src="warning.png"></td><th align="left">Warning</th></tr><tr><td align="left" valign="top"><p>

This chapter is in the process of being re-written.

The rewrite is not complete yet.

- </p></td></tr></table></div><div class="sect1" title="1. Quick Start"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e465"></a>1. Quick Start</h2></div></div></div><p>

+ </p></td></tr></table></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e465"></a>1. Quick Start</h2></div></div></div><p>

If you are running <span class="application">FindBugs</span> on a Windows system,

double-click on the file <code class="filename"><em class="replaceable"><code>%FINDBUGS_HOME%</code></em>\lib\findbugs.jar</code> to start the <span class="application">FindBugs</span> GUI.

</p><p>

@@ -17,11 +17,11 @@ how to run each of these user interfaces.

to run the <span class="application">FindBugs</span> GUI.

</p><p>

Refer to <a class="xref" href="gui.html" title="Chapter 5. Using the FindBugs GUI">Chapter 5, <i>Using the <span class="application">FindBugs</span> GUI</i></a> for information on how to use the GUI.

- </p></div><div class="sect1" title="2. Executing FindBugs"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e503"></a>2. Executing <span class="application">FindBugs</span></h2></div></div></div><p>

+ </p></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e503"></a>2. Executing <span class="application">FindBugs</span></h2></div></div></div><p>

This section describes how to invoke the <span class="application">FindBugs</span> program.

There are two ways to invoke <span class="application">FindBugs</span>: directly, or using a

wrapper script.

- </p><div class="sect2" title="2.1. Direct invocation of FindBugs"><div class="titlepage"><div><div><h3 class="title"><a name="directInvocation"></a>2.1. Direct invocation of <span class="application">FindBugs</span></h3></div></div></div><p>

+ </p><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a name="directInvocation"></a>2.1. Direct invocation of <span class="application">FindBugs</span></h3></div></div></div><p>

The preferred method of running <span class="application">FindBugs</span> is to directly execute

<code class="filename"><em class="replaceable"><code>$FINDBUGS_HOME</code></em>/lib/findbugs.jar</code> using the <span class="command"><strong>-jar</strong></span>

command line switch of the JVM (<span class="command"><strong>java</strong></span>) executable.

@@ -32,10 +32,10 @@ how to run each of these user interfaces.

</p><pre class="screen">

<span class="command"><strong>java <em class="replaceable"><code>[JVM arguments]</code></em> -jar <em class="replaceable"><code>$FINDBUGS_HOME</code></em>/lib/findbugs.jar <em class="replaceable"><code>options...</code></em></strong></span>

</pre><p>

- </p><div class="sect3" title="2.1.1. Choosing the User Interface"><div class="titlepage"><div><div><h4 class="title"><a name="chooseUI"></a>2.1.1. Choosing the User Interface</h4></div></div></div><p>

+ </p><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a name="chooseUI"></a>2.1.1. Choosing the User Interface</h4></div></div></div><p>

The first command line option chooses the <span class="application">FindBugs</span> user interface to execute.

Possible values are:

- </p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>

+ </p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>

<span class="command"><strong>-gui</strong></span>: runs the graphical user interface (GUI)

</p></li><li class="listitem"><p>

<span class="command"><strong>-textui</strong></span>: runs the command line user interface

@@ -47,10 +47,10 @@ how to run each of these user interfaces.

</p></li><li class="listitem"><p>

<span class="command"><strong>-gui1</strong></span>: executes the original (obsolete)

<span class="application">FindBugs</span> graphical user interface

- </p></li></ul></div></div><div class="sect3" title="2.1.2. Java Virtual Machine (JVM) arguments"><div class="titlepage"><div><div><h4 class="title"><a name="jvmArgs"></a>2.1.2. Java Virtual Machine (JVM) arguments</h4></div></div></div><p>

+ </p></li></ul></div></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a name="jvmArgs"></a>2.1.2. Java Virtual Machine (JVM) arguments</h4></div></div></div><p>

Several Java Virtual Machine arguments are useful when invoking

<span class="application">FindBugs</span>.

- </p><div class="variablelist"><dl><dt><span class="term"><span class="command"><strong>-Xmx<em class="replaceable"><code>NN</code></em>m</strong></span></span></dt><dd><p>

+ </p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><span class="command"><strong>-Xmx<em class="replaceable"><code>NN</code></em>m</strong></span></span></dt><dd><p>

Set the maximum Java heap size to <em class="replaceable"><code>NN</code></em>

megabytes. <span class="application">FindBugs</span> generally requires a large amount of

memory. For a very large project, using 1500 megabytes

@@ -59,7 +59,7 @@ how to run each of these user interfaces.

Set a Java system property. For example, you might use the

argument <span class="command"><strong>-Duser.language=ja</strong></span> to display

GUI messages in Japanese.

- </p></dd></dl></div></div></div><div class="sect2" title="2.2. Invocation of FindBugs using a wrapper script"><div class="titlepage"><div><div><h3 class="title"><a name="wrapperScript"></a>2.2. Invocation of <span class="application">FindBugs</span> using a wrapper script</h3></div></div></div><p>

+ </p></dd></dl></div></div></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a name="wrapperScript"></a>2.2. Invocation of <span class="application">FindBugs</span> using a wrapper script</h3></div></div></div><p>

Another way to run <span class="application">FindBugs</span> is to use a wrapper script.

</p><p>

On Unix-like systems, use the following command to invoke the wrapper script:

@@ -75,11 +75,11 @@ On Windows systems, the command to invoke the wrapper script is

On both Unix-like and Windows systems, you can simply add the <code class="filename"><em class="replaceable"><code>$FINDBUGS_HOME</code></em>/bin</code>

directory to your <code class="filename">PATH</code> environment variable and then invoke

FindBugs using the <span class="command"><strong>findbugs</strong></span> command.

-</p><div class="sect3" title="2.2.1. Wrapper script command line options"><div class="titlepage"><div><div><h4 class="title"><a name="wrapperOptions"></a>2.2.1. Wrapper script command line options</h4></div></div></div><p>The <span class="application">FindBugs</span> wrapper scripts support the following command-line options.

+</p><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a name="wrapperOptions"></a>2.2.1. Wrapper script command line options</h4></div></div></div><p>The <span class="application">FindBugs</span> wrapper scripts support the following command-line options.

Note that these command line options are <span class="emphasis"><em>not</em></span> handled by

the <span class="application">FindBugs</span> program per se; rather, they are handled by the wrapper

script.

- </p><div class="variablelist"><dl><dt><span class="term"><span class="command"><strong>-jvmArgs <em class="replaceable"><code>args</code></em></strong></span></span></dt><dd><p>

+ </p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><span class="command"><strong>-jvmArgs <em class="replaceable"><code>args</code></em></strong></span></span></dt><dd><p>

Specifies arguments to pass to the JVM. For example, you might want

to set a JVM property:

</p><pre class="screen">

@@ -100,13 +100,13 @@ FindBugs using the <span class="command"><strong>findbugs</strong></span> comman

You can use this option multiple times in order to set multiple properties.

Note: In most versions of Windows, the <em class="replaceable"><code>name=value</code></em>

string must be in quotes.

- </p></dd></dl></div></div></div></div><div class="sect1" title="3. Command-line Options"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="commandLineOptions"></a>3. Command-line Options</h2></div></div></div><p>

+ </p></dd></dl></div></div></div></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="commandLineOptions"></a>3. Command-line Options</h2></div></div></div><p>

This section describes the command line options supported by <span class="application">FindBugs</span>.

These command line options may be used when invoking <span class="application">FindBugs</span> directly,

or when using a wrapper script.

-</p><div class="sect2" title="3.1. Common command-line options"><div class="titlepage"><div><div><h3 class="title"><a name="d0e796"></a>3.1. Common command-line options</h3></div></div></div><p>

+</p><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a name="d0e796"></a>3.1. Common command-line options</h3></div></div></div><p>

These options may be used with both the GUI and command-line interfaces.

-</p><div class="variablelist"><dl><dt><span class="term"><span class="command"><strong>-effort:min</strong></span></span></dt><dd><p>

+</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><span class="command"><strong>-effort:min</strong></span></span></dt><dd><p>

This option disables analyses that increase precision but also

increase memory consumption. You may want to try this option if

you find that <span class="application">FindBugs</span> runs out of memory, or takes an unusually

@@ -118,15 +118,15 @@ These options may be used with both the GUI and command-line interfaces.

Specify a project to be analyzed. The project file you specify should

be one that was created using the GUI interface. It will typically end

in the extension <code class="filename">.fb</code> or <code class="filename">.fbp</code>.

- </p></dd></dl></div></div><div class="sect2" title="3.2. GUI Options"><div class="titlepage"><div><div><h3 class="title"><a name="d0e836"></a>3.2. GUI Options</h3></div></div></div><p>

+ </p></dd></dl></div></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a name="d0e836"></a>3.2. GUI Options</h3></div></div></div><p>

These options are only accepted by the Graphical User Interface.

-</p><div class="variablelist"><dl><dt><span class="term"><span class="command"><strong>-look:</strong></span><em class="replaceable"><code>plastic|gtk|native</code></em></span></dt><dd><p>

+</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><span class="command"><strong>-look:</strong></span><em class="replaceable"><code>plastic|gtk|native</code></em></span></dt><dd><p>

Set Swing look and feel.

</p></dd></dl></div><p>

-</p></div><div class="sect2" title="3.3. Text UI Options"><div class="titlepage"><div><div><h3 class="title"><a name="d0e852"></a>3.3. Text UI Options</h3></div></div></div><p>

+</p></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a name="d0e852"></a>3.3. Text UI Options</h3></div></div></div><p>

These options are only accepted by the Text User Interface.

-</p><div class="variablelist"><dl><dt><span class="term"><span class="command"><strong>-sortByClass</strong></span></span></dt><dd><p>

+</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><span class="command"><strong>-sortByClass</strong></span></span></dt><dd><p>

Sort reported bug instances by class name.

</p></dd><dt><span class="term"><span class="command"><strong>-include</strong></span> <em class="replaceable"><code>filterFile.xml</code></em></span></dt><dd><p>

Only report bug instances that match the filter specified by <em class="replaceable"><code>filterFile.xml</code></em>.

@@ -200,6 +200,15 @@ These options are only accepted by the Text User Interface.

Set the auxiliary classpath for analysis. This classpath should include all

jar files and directories containing classes that are part of the program

being analyzed but you do not want to have analyzed for bugs.

+ </p></dd><dt><span class="term"><span class="command"><strong>-auxclasspathFromInput</strong></span> </span></dt><dd><p>

+ Read the auxiliary classpath for analysis from standard input, each line adds new

+ entry to the auxiliary classpath for analysis.

+ </p></dd><dt><span class="term"><span class="command"><strong>-auxclasspathFromFile</strong></span> <em class="replaceable"><code>filepath</code></em></span></dt><dd><p>

+ Read the auxiliary classpath for analysis from file, each line adds new

+ entry to the auxiliary classpath for analysis.

+ </p></dd><dt><span class="term"><span class="command"><strong>-analyzeFromFile</strong></span> <em class="replaceable"><code>filepath</code></em></span></dt><dd><p>

+ Read the files to analyze from file, each line adds new

+ entry to the classpath for analysis.

</p></dd><dt><span class="term"><span class="command"><strong>-userPrefs</strong></span> <em class="replaceable"><code>edu.umd.cs.findbugs.core.prefs</code></em></span></dt><dd><p>

Set the path of the user preferences file to use, which might override some of the options abobe.

Specifying <code class="literal">userPrefs</code> as first argument would mean some later

« README.chromium ('K') | « doc/manual/rejarForAnalysis.html ('k') | doc/manual_ja.xml » ('j') | no next file with comments »