doc/manual/filter.html - Issue 594833004: Roll FindBugs from 2.0.3 to 3.0.0

Unified Diff: doc/manual/filter.html

Issue 594833004: Roll FindBugs from 2.0.3 to 3.0.0 (Closed) Base URL: https://chromium.googlesource.com/chromium/deps/findbugs.git@master

Patch Set: Created 6 years, 3 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/filter.html

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

index 98b264f24dd4c9f590d0957f6025230265e51d70..0483ef43b2b5e3e5af4b1069b95c844c3d16ba86 100644

--- a/doc/manual/filter.html

+++ b/doc/manual/filter.html

@@ -1,6 +1,6 @@

- <title>Chapter 8. Filter Files</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="eclipse.html" title="Chapter 7. Using the FindBugs™ Eclipse plugin"><link rel="next" href="analysisprops.html" title="Chapter 9. Analysis Properties"></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 8. Filter Files</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="eclipse.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="analysisprops.html">Next</a></td></tr></table><hr></div><div class="chapter" title="Chapter 8. Filter Files"><div class="titlepage"><div><div><h2 class="title"><a name="filter"></a>Chapter 8. Filter Files</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a href="filter.html#d0e1838">1. Introduction to Filter Files</a></span></dt><dt><span class="sect1"><a href="filter.html#d0e1888">2. Types of Match clauses</a></span></dt><dt><span class="sect1"><a href="filter.html#d0e2136">3. Java element name matching</a></span></dt><dt><span class="sect1"><a href="filter.html#d0e2161">4. Caveats</a></span></dt><dt><span class="sect1"><a href="filter.html#d0e2191">5. Examples</a></span></dt><dt><span class="sect1"><a href="filter.html#d0e2249">6. Complete Example</a></span></dt></dl></div><p>

+ <title>Chapter 8. Filter Files</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="eclipse.html" title="Chapter 7. Using the FindBugs™ Eclipse plugin"><link rel="next" href="analysisprops.html" title="Chapter 9. Analysis Properties"></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 8. Filter Files</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="eclipse.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="analysisprops.html">Next</a></td></tr></table><hr></div><div class="chapter" title="Chapter 8. Filter Files"><div class="titlepage"><div><div><h2 class="title"><a name="filter"></a>Chapter 8. Filter Files</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a href="filter.html#d0e1879">1. Introduction to Filter Files</a></span></dt><dt><span class="sect1"><a href="filter.html#d0e1929">2. Types of Match clauses</a></span></dt><dt><span class="sect1"><a href="filter.html#d0e2187">3. Java element name matching</a></span></dt><dt><span class="sect1"><a href="filter.html#d0e2215">4. Caveats</a></span></dt><dt><span class="sect1"><a href="filter.html#d0e2245">5. Examples</a></span></dt><dt><span class="sect1"><a href="filter.html#d0e2308">6. Complete Example</a></span></dt></dl></div><p>

Filter files may be used to include or exclude bug reports for particular classes

and methods. This chapter explains how to use filter files.

@@ -8,7 +8,7 @@ and methods. This chapter explains how to use filter files.

Filters are currently only supported by the Command Line interface.

Eventually, filter support will be added to the GUI.

</p></td></tr></table></div><p>

-</p><div class="sect1" title="1. Introduction to Filter Files"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e1838"></a>1. Introduction to Filter Files</h2></div></div></div><p>

+</p><div class="sect1" title="1. Introduction to Filter Files"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e1879"></a>1. Introduction to Filter Files</h2></div></div></div><p>

Conceptually, a filter matches bug instances against a set of criteria.

By defining a filter, you can select bug instances for special treatment;

for example, to exclude or include them in a report.

@@ -31,7 +31,7 @@ report:

</p><p>

<code class="literal">Match</code> elements contain children, which are conjuncts of the predicate.

In other words, each of the children must be true for the predicate to be true.

-</p></div><div class="sect1" title="2. Types of Match clauses"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e1888"></a>2. Types of Match clauses</h2></div></div></div><div class="variablelist"><dl><dt><span class="term"><code class="literal"><Bug></code></span></dt><dd><p>

+</p></div><div class="sect1" title="2. Types of Match clauses"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e1929"></a>2. Types of Match clauses</h2></div></div></div><div class="variablelist"><dl><dt><span class="term"><code class="literal"><Bug></code></span></dt><dd><p>

This element specifies a particular bug pattern or patterns to match.

The <code class="literal">pattern</code> attribute is a comma-separated list of

bug pattern types. You can find the bug pattern types for particular

@@ -87,6 +87,10 @@ In other words, each of the children must be true for the predicate to be true.

nor a <code class="literal">class</code> / <code class="literal">classregex</code> attribute, the predicate will apply

to all classes. Such predicate is likely to match more bug instances than you want, unless it is

refined further down with apropriate method or field predicates.

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

+ This element matches warnings associated with a particular source file. The

+ <code class="literal">name</code> attribute is used to specify the exact or regex match pattern

+ for the source file name.

</p></dd><dt><span class="term"><code class="literal"><Method></code></span></dt><dd><p>This element specifies a method. The <code class="literal">name</code> is used to specify

the exact or regex match pattern for the method name.

The <code class="literal">params</code> attribute is a comma-separated list

@@ -108,15 +112,16 @@ In other words, each of the children must be true for the predicate to be true.

<code class="literal">Method</code> elements in an <code class="literal">Or</code> clause in order to match either method.

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

This element combines <code class="literal">Match</code> clauses which both must evaluate to true. I.e., you can put

- <code class="literal">Bug</code> and <code class="literal">Priority</code> elements in an <code class="literal">And</code> clause in order

- to match specific bugs with given priority only.

+ <code class="literal">Bug</code> and <code class="literal">Confidence</code> elements in an <code class="literal">And</code> clause in order

+ to match specific bugs with given confidence only.

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

This element inverts the included child <code class="literal">Match</code>. I.e., you can put a

<code class="literal">Bug</code> element in a <code class="literal">Not</code> clause in order to match any bug

excluding the given one.

- </p></dd></dl></div></div><div class="sect1" title="3. Java element name matching"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e2136"></a>3. Java element name matching</h2></div></div></div><p>

-If the <code class="literal">name</code> attribute of <code class="literal">Class</code>, <code class="literal">Method</code> or

-<code class="literal">Field</code> starts with the ~ character the rest of attribute content is interpreted as

+ </p></dd></dl></div></div><div class="sect1" title="3. Java element name matching"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e2187"></a>3. Java element name matching</h2></div></div></div><p>

+If the <code class="literal">name</code> attribute of <code class="literal">Class</code>, <code class="literal">Source</code>,

+<code class="literal">Method</code> or <code class="literal">Field</code> starts with the ~ character

+the rest of attribute content is interpreted as

a Java regular expression that is matched against the names of the Java element in question.

</p><p>

Note that the pattern is matched against whole element name and therefore .* clauses need to be used

@@ -124,7 +129,7 @@ at pattern beginning and/or end to perform substring matching.

</p><p>

See <a class="ulink" href="http://java.sun.com/j2se/1.5.0/docs/api/java/util/regex/Pattern.html" target="_top"><code class="literal">java.util.regex.Pattern</code></a>

documentation for pattern syntax.

-</p></div><div class="sect1" title="4. Caveats"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e2161"></a>4. Caveats</h2></div></div></div><p>

+</p></div><div class="sect1" title="4. Caveats"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e2215"></a>4. Caveats</h2></div></div></div><p>

<code class="literal">Match</code> clauses can only match information that is actually contained in the

bug instances. Every bug instance has a class, so in general, excluding

bugs by class will work.

@@ -158,7 +163,7 @@ class.)

Many kinds of bugs report what method they occur in. For those bug instances,

you can put <code class="literal">Method</code> clauses in the <code class="literal">Match</code> element and they should work

as expected.

-</p></div><div class="sect1" title="5. Examples"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e2191"></a>5. Examples</h2></div></div></div><p>

+</p></div><div class="sect1" title="5. Examples"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e2245"></a>5. Examples</h2></div></div></div><p>

1. Match all bug reports for a class.

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

@@ -314,7 +319,20 @@ as expected.

</Match>

</pre><p>

-</p></div><div class="sect1" title="6. Complete Example"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e2249"></a>6. Complete Example</h2></div></div></div><pre class="programlisting">

+</p><p>

+ 12. Full exclusion filter file to match all classes generated from Groovy source files.

+</p><pre class="programlisting">

+<?xml version="1.0" encoding="UTF-8"?>

+<FindBugsFilter>

+<Match>

+ <Source name="~.*\.groovy" />

+</Match>

+</FindBugsFilter>

+</pre><p>

+</p></div><div class="sect1" title="6. Complete Example"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e2308"></a>6. Complete Example</h2></div></div></div><pre class="programlisting">

<Match>

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