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

Unified Diff: doc/manual/filter.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: rebase again 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/filter.html

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

index 0483ef43b2b5e3e5af4b1069b95c844c3d16ba86..975f3af5369e97bf46d21dbc1a8e19e637e17de6 100644

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

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

@@ -1,14 +1,9 @@

- <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>

+ <title>Chapter 8. Filter Files</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="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"><div class="titlepage"><div><div><h1 class="title"><a name="filter"></a>Chapter 8. Filter Files</h1></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl class="toc"><dt><span class="sect1"><a href="filter.html#d0e1880">1. Introduction to Filter Files</a></span></dt><dt><span class="sect1"><a href="filter.html#d0e1930">2. Types of Match clauses</a></span></dt><dt><span class="sect1"><a href="filter.html#d0e2197">3. Java element name matching</a></span></dt><dt><span class="sect1"><a href="filter.html#d0e2225">4. Caveats</a></span></dt><dt><span class="sect1"><a href="filter.html#d0e2255">5. Examples</a></span></dt><dt><span class="sect1"><a href="filter.html#d0e2318">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.

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

- 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="d0e1879"></a>1. Introduction to Filter Files</h2></div></div></div><p>

+</p><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e1880"></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 +26,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="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>

+</p></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e1930"></a>2. Types of Match clauses</h2></div></div></div><div class="variablelist"><dl class="variablelist"><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

@@ -76,7 +71,7 @@ In other words, each of the children must be true for the predicate to be true.

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

This element matches warnings associated with a particular class. The

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

- for the class name.

+ for the class name. The <code class="literal">role</code> attribute is the class role.

</p><p>

As a backward compatibility measure, instead of element of this type, you can use

<code class="literal">class</code> attribute on a <code class="literal">Match</code> element to specify

@@ -95,7 +90,8 @@ In other words, each of the children must be true for the predicate to be true.

the exact or regex match pattern for the method name.

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

of the types of the method's parameters. The <code class="literal">returns</code> attribute is

- the method's return type. In <code class="literal">params</code> and <code class="literal">returns</code>, class names

+ the method's return type. The <code class="literal">role</code> attribute is

+ the method role. In <code class="literal">params</code> and <code class="literal">returns</code>, class names

must be fully qualified. (E.g., "java.lang.String" instead of just

"String".) If one of the latter attributes is specified the other is required for creating a method signature.

Note that you can provide either <code class="literal">name</code> attribute or <code class="literal">params</code>

@@ -104,7 +100,8 @@ In other words, each of the children must be true for the predicate to be true.

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

the exact or regex match pattern for the field name. You can also filter fields according to their signature -

use <code class="literal">type</code> attribute to specify fully qualified type of the field. You can specify eiter or both

- of these attributes in order to perform name / signature based matches.

+ of these attributes in order to perform name / signature based matches. The <code class="literal">role</code> attribute is

+ the field role.

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

the exact or regex match pattern for the local variable name. Local variables are variables defined within a method.

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

@@ -118,7 +115,7 @@ In other words, each of the children must be true for the predicate to be true.

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="d0e2187"></a>3. Java element name matching</h2></div></div></div><p>

+ </p></dd></dl></div></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e2197"></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

@@ -129,7 +126,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="d0e2215"></a>4. Caveats</h2></div></div></div><p>

+</p></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e2225"></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.

@@ -163,7 +160,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="d0e2245"></a>5. Examples</h2></div></div></div><p>

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

1. Match all bug reports for a class.

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

@@ -332,7 +329,7 @@ as expected.

</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">

+</p></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e2318"></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 »