Index: doc/manual/anttask.html |
diff --git a/doc/manual/anttask.html b/doc/manual/anttask.html |
index e601e1ffe443cd6aa30287a799874223060acfa8..53a058e2f52329803156d2797439b3d6618eeaed 100644 |
--- a/doc/manual/anttask.html |
+++ b/doc/manual/anttask.html |
@@ -1,20 +1,20 @@ |
<html><head> |
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> |
- <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> |
+ <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#d0e1233">1. Installing the <span class="application">Ant</span> task</a></span></dt><dt><span class="sect1"><a href="anttask.html#d0e1271">2. Modifying build.xml</a></span></dt><dt><span class="sect1"><a href="anttask.html#d0e1342">3. Executing the task</a></span></dt><dt><span class="sect1"><a href="anttask.html#d0e1367">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="d0e1205"></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="d0e1233"></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="d0e1243"></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="d0e1271"></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="d0e1314"></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="d0e1342"></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="d0e1339"></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="d0e1367"></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> |
@@ -159,8 +159,12 @@ using the <span class="application">FindBugs</span> task. |
without any package qualification. By default, all detectors which are |
not disabled by default are run. |
</p></dd><dt><span class="term"><code class="literal">omitVisitors</code></span></dt><dd><p> |
- Optional attribute. It is like the <code class="literal">visitors</code> attribute, |
+ Optional attribute. It specifies a comma-separated list of bug detectors. |
+ It is like the <code class="literal">visitors</code> attribute, |
except it specifies detectors which will <span class="emphasis"><em>not</em></span> be run. |
+ </p></dd><dt><span class="term"><code class="literal">chooseVisitors</code></span></dt><dd><p> |
+ Optional attribute. It specifies a comma-separated list of bug detectors |
+ prefixed with "+" or "-" to selectively enable/disable them. |
</p></dd><dt><span class="term"><code class="literal">excludeFilter</code></span></dt><dd><p> |
Optional attribute. It specifies the filename of a filter specifying bugs |
to exclude from being reported. See <a class="xref" href="filter.html" title="Chapter 8. Filter Files">Chapter 8, <i>Filter Files</i></a>. |
@@ -208,7 +212,11 @@ using the <span class="application">FindBugs</span> task. |
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></dd><dt><span class="term"><code class="literal">nested</code></span></dt><dd><p> |
+ Optional attribute which enables or disables scanning of nested jar and zip files found in |
+ the list of files and directories to be analyzed. |
+ By default, scanning of nested jar/zip files is enabled. |
+ </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> |