doc/manual/anttask.html - Issue 139673002: Updating Findbugs from 2.0.1 to 2.0.3

Unified Diff: doc/manual/anttask.html

Issue 139673002: Updating Findbugs from 2.0.1 to 2.0.3 (Closed) Base URL: https://chromium.googlesource.com/chromium/deps/findbugs.git@master

Patch Set: bulach's nits Created 6 years, 11 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/anttask.html

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

index d222a1bd5aabf3f68668ff6d0d67124cae7130ba..e601e1ffe443cd6aa30287a799874223060acfa8 100644

--- a/doc/manual/anttask.html

+++ b/doc/manual/anttask.html

@@ -1,20 +1,20 @@

- <title>Chapter 6. Using the FindBugs™ Ant task</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="gui.html" title="Chapter 5. Using the FindBugs GUI"><link rel="next" href="eclipse.html" title="Chapter 7. Using the FindBugs™ Eclipse plugin"></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 6. Using the <span class="application">FindBugs</span>™ <span class="application">Ant</span> task</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="gui.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="eclipse.html">Next</a></td></tr></table><hr></div><div class="chapter" title="Chapter 6. Using the FindBugs™ Ant task"><div class="titlepage"><div><div><h2 class="title"><a name="anttask"></a>Chapter 6. Using the <span class="application">FindBugs</span>™ <span class="application">Ant</span> task</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a href="anttask.html#d0e1192">1. Installing the <span class="application">Ant</span> task</a></span></dt><dt><span class="sect1"><a href="anttask.html#d0e1230">2. Modifying build.xml</a></span></dt><dt><span class="sect1"><a href="anttask.html#d0e1301">3. Executing the task</a></span></dt><dt><span class="sect1"><a href="anttask.html#d0e1326">4. Parameters</a></span></dt></dl></div><p>

+ <title>Chapter 6. Using the FindBugs™ Ant task</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="gui.html" title="Chapter 5. Using the FindBugs GUI"><link rel="next" href="eclipse.html" title="Chapter 7. Using the FindBugs™ Eclipse plugin"></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 6. Using the <span class="application">FindBugs</span>™ <span class="application">Ant</span> task</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="gui.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="eclipse.html">Next</a></td></tr></table><hr></div><div class="chapter" title="Chapter 6. Using the FindBugs™ Ant task"><div class="titlepage"><div><div><h2 class="title"><a name="anttask"></a>Chapter 6. Using the <span class="application">FindBugs</span>™ <span class="application">Ant</span> task</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a href="anttask.html#d0e1205">1. Installing the <span class="application">Ant</span> task</a></span></dt><dt><span class="sect1"><a href="anttask.html#d0e1243">2. Modifying build.xml</a></span></dt><dt><span class="sect1"><a href="anttask.html#d0e1314">3. Executing the task</a></span></dt><dt><span class="sect1"><a href="anttask.html#d0e1339">4. Parameters</a></span></dt></dl></div><p>

This chapter describes how to integrate <span class="application">FindBugs</span> into a build script

for <a class="ulink" href="http://ant.apache.org/" target="_top"><span class="application">Ant</span></a>, which is a popular Java build

and deployment tool. Using the <span class="application">FindBugs</span> <span class="application">Ant</span> task, your build script can

automatically run <span class="application">FindBugs</span> on your Java code.

</p><p>

The <span class="application">Ant</span> task was generously contributed by Mike Fagan.

-</p><div class="sect1" title="1. Installing the Ant task"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e1192"></a>1. Installing the <span class="application">Ant</span> task</h2></div></div></div><p>

+</p><div class="sect1" title="1. Installing the Ant task"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e1205"></a>1. Installing the <span class="application">Ant</span> task</h2></div></div></div><p>

To install the <span class="application">Ant</span> task, simply copy <code class="filename"><em class="replaceable"><code>$FINDBUGS_HOME</code></em>/lib/findbugs-ant.jar</code>

into the <code class="filename">lib</code> subdirectory of your <span class="application">Ant</span> installation.

</p><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="note.png"></td><th align="left">Note</th></tr><tr><td align="left" valign="top"><p>It is strongly recommended that you use the <span class="application">Ant</span> task with the version

of <span class="application">FindBugs</span> it was included with. We do not guarantee that the <span class="application">Ant</span> task Jar file

will work with any version of <span class="application">FindBugs</span> other than the one it was included with.</p></td></tr></table></div><p>

-</p></div><div class="sect1" title="2. Modifying build.xml"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e1230"></a>2. Modifying build.xml</h2></div></div></div><p>

+</p></div><div class="sect1" title="2. Modifying build.xml"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e1243"></a>2. Modifying build.xml</h2></div></div></div><p>

To incorporate <span class="application">FindBugs</span> into <code class="filename">build.xml</code> (the build script

for <span class="application">Ant</span>), you first need to add a task definition. This should appear as follows:

@@ -56,7 +56,7 @@ The output of <span class="application">FindBugs</span> will be saved in XML for

An auxiliary Jar file, <code class="filename">Regex.jar</code>, is added to the aux classpath,

because it is referenced by the main BCEL library. A source path is specified

so that the saved bug data will have accurate references to the BCEL source code.

-</p></div><div class="sect1" title="3. Executing the task"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e1301"></a>3. Executing the task</h2></div></div></div><p>

+</p></div><div class="sect1" title="3. Executing the task"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e1314"></a>3. Executing the task</h2></div></div></div><p>

Here is an example of invoking <span class="application">Ant</span> from the command line, using the <code class="literal">findbugs</code>

target defined above.

@@ -83,7 +83,7 @@ target defined above.

In this case, because we saved the bug results in an XML file, we can

use the <span class="application">FindBugs</span> GUI to view the results; see <a class="xref" href="running.html" title="Chapter 4. Running FindBugs™">Chapter 4, <i>Running <span class="application">FindBugs</span>™</i></a>.

-</p></div><div class="sect1" title="4. Parameters"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e1326"></a>4. Parameters</h2></div></div></div><p>This section describes the parameters that may be specified when

+</p></div><div class="sect1" title="4. Parameters"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e1339"></a>4. Parameters</h2></div></div></div><p>This section describes the parameters that may be specified when

using the <span class="application">FindBugs</span> task.

</p><div class="variablelist"><dl><dt><span class="term"><code class="literal">class</code></span></dt><dd><p>

@@ -92,8 +92,8 @@ using the <span class="application">FindBugs</span> task.

archive file (jar, zip, etc.), directory, or class file to be analyzed. Multiple <code class="literal">class</code>

elements may be specified as children of a single <code class="literal">findbugs</code> element.

</p><p>In addition to or instead of specifying a <code class="literal">class</code> element,

- the <span class="application">FindBugs</span> task can contain one or more <code class="literal">fileset</code> element(s) that

- specify files to be analyzed.

+ the <span class="application">FindBugs</span> task can contain one or more <code class="literal">fileset</code> element(s) that

+ specify files to be analyzed.

For example, you might use a fileset to specify that all of the jar files in a directory

should be analyzed.

</p></dd><dt><span class="term"><code class="literal">auxClasspath</code></span></dt><dd><p>

@@ -117,7 +117,7 @@ using the <span class="application">FindBugs</span> task.

</p></dd><dt><span class="term"><code class="literal">reportLevel</code></span></dt><dd><p>

An optional attribute. It specifies

the confidence/priority threshold for reporting issues. If set to "low", confidence is not used to filter bugs.

- If set to "medium" (the default), low confidence issues are supressed.

+ If set to "medium" (the default), low confidence issues are supressed.

If set to "high", only high confidence bugs are reported.

</p></dd><dt><span class="term"><code class="literal">output</code></span></dt><dd><p>

Optional attribute.

@@ -202,7 +202,13 @@ using the <span class="application">FindBugs</span> task.

Optional attribute which specifies the name of a property

that will be set to "true" if any warnings are reported by

<span class="application">FindBugs</span> on the analyzed program.

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

+ </p></dd><dt><span class="term"><code class="literal">userPreferencesFile</code></span></dt><dd><p>

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

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

+ options will override them, as last argument would mean they will override some previous options).

+ This rationale behind this option is to reuse FindBugs Eclipse project settings for command

+ line execution.

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

</p></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="gui.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="eclipse.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Chapter 5. Using the <span class="application">FindBugs</span> GUI </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Chapter 7. Using the <span class="application">FindBugs</span>™ Eclipse plugin</td></tr></table></div></body></html>

« no previous file with comments | « doc/manual/acknowledgments.html ('k') | doc/manual/building.html » ('j') | no next file with comments »