Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(2615)

Unified Diff: doc/manual.xml

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
« no previous file with comments | « doc/mailingLists.html ('k') | doc/manual.xsl » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: doc/manual.xml
diff --git a/doc/manual.xml b/doc/manual.xml
index 57914ced2fde823152e84d94981b74fcf59af99d..2cd779bb51e318b9b877df093e5030a11a75e8af 100644
--- a/doc/manual.xml
+++ b/doc/manual.xml
@@ -44,9 +44,9 @@ The name FindBugs and the FindBugs logo are trademarked by the University of Mar
</para>
</legalnotice>
-<edition>3.0.0</edition>
+<edition>3.0.1</edition>
-<pubdate>20:25:27 CDT, 06 July, 2014</pubdate>
+<pubdate>12:37:51 EST, 06 March, 2015</pubdate>
</bookinfo>
@@ -62,7 +62,7 @@ The name FindBugs and the FindBugs logo are trademarked by the University of Mar
<para> &FindBugs;&trade; is a program to find bugs in Java programs. It looks for instances
of "bug patterns" --- code instances that are likely to be errors.</para>
-<para> This document describes version 3.0.0 of &FindBugs;.We
+<para> This document describes version 3.0.1 of &FindBugs;.We
are very interested in getting your feedback on &FindBugs;. Please visit
the <ulink url="http://findbugs.sourceforge.net">&FindBugs; web page</ulink> for
the latest information on &FindBugs;, contact information, and support resources such
@@ -100,31 +100,31 @@ This chapter explains how to install &FindBugs;.
<para>
The easiest way to install &FindBugs; is to download a binary distribution.
Binary distributions are available in
-<ulink url="http://prdownloads.sourceforge.net/findbugs/findbugs-3.0.0.tar.gz?download">gzipped tar format</ulink> and
-<ulink url="http://prdownloads.sourceforge.net/findbugs/findbugs-3.0.0.zip?download">zip format</ulink>.
+<ulink url="http://prdownloads.sourceforge.net/findbugs/findbugs-3.0.1.tar.gz?download">gzipped tar format</ulink> and
+<ulink url="http://prdownloads.sourceforge.net/findbugs/findbugs-3.0.1.zip?download">zip format</ulink>.
Once you have downloaded a binary distribution, extract it into a directory of your choice.
</para>
<para>
Extracting a gzipped tar format distribution:
<screen>
-<prompt>$ </prompt><command>gunzip -c findbugs-3.0.0.tar.gz | tar xvf -</command>
+<prompt>$ </prompt><command>gunzip -c findbugs-3.0.1.tar.gz | tar xvf -</command>
</screen>
</para>
<para>
Extracting a zip format distribution:
<screen>
-<prompt>C:\Software></prompt><command>unzip findbugs-3.0.0.zip</command>
+<prompt>C:\Software></prompt><command>unzip findbugs-3.0.1.zip</command>
</screen>
</para>
<para>
Usually, extracting a binary distribution will create a directory ending in
-<filename class="directory">findbugs-3.0.0</filename>. For example, if you extracted
+<filename class="directory">findbugs-3.0.1</filename>. For example, if you extracted
the binary distribution from the <filename class="directory">C:\Software</filename>
directory, then the &FindBugs; software will be extracted into the directory
-<filename class="directory">C:\Software\findbugs-3.0.0</filename>.
+<filename class="directory">C:\Software\findbugs-3.0.1</filename>.
This directory is the &FindBugs; home directory. We'll refer to it as
&FBHome; (or &FBHomeWin; for Windows) throughout this manual.
</para>
@@ -155,7 +155,7 @@ To compile &FindBugs; from source, you will need the following:
<itemizedlist>
<listitem>
<para>
- The <ulink url="http://prdownloads.sourceforge.net/findbugs/findbugs-3.0.0-source.zip?download"
+ The <ulink url="http://prdownloads.sourceforge.net/findbugs/findbugs-3.0.1-source.zip?download"
>&FindBugs; source distribution</ulink>
</para>
</listitem>
@@ -218,7 +218,7 @@ After you download the source distribution, you'll need to extract it into
a working directory. A typical command to do this is:
<screen>
-<prompt>$ </prompt><command>unzip findbugs-3.0.0-source.zip</command>
+<prompt>$ </prompt><command>unzip findbugs-3.0.1-source.zip</command>
</screen>
</para>
@@ -1591,6 +1591,16 @@ using the &FindBugs; task.
</listitem>
</varlistentry>
+ <varlistentry>
+ <term><literal>setExitCode</literal></term>
+ <listitem>
+ <para>
+ Optional boolean attribute. Whether the exit code will be returned to
+ the main ant job. Defaults to "true".
+ </para>
+ </listitem>
+ </varlistentry>
+
</variablelist>
@@ -1669,10 +1679,10 @@ and JRE/JDK 1.5 or later.
<para>You can also manually
download the plugin from the following link:
-<ulink url="http://prdownloads.sourceforge.net/findbugs/edu.umd.cs.findbugs.plugin.eclipse_3.0.0.20140706.zip?download"
->http://prdownloads.sourceforge.net/findbugs/edu.umd.cs.findbugs.plugin.eclipse_3.0.0.20140706.zip?download</ulink>.
+<ulink url="http://prdownloads.sourceforge.net/findbugs/edu.umd.cs.findbugs.plugin.eclipse_3.0.1.20150306.zip?download"
+>http://prdownloads.sourceforge.net/findbugs/edu.umd.cs.findbugs.plugin.eclipse_3.0.1.20150306.zip?download</ulink>.
Extract it in Eclipse's "plugins" subdirectory.
-(So &lt;eclipse_install_dir&gt;/plugins/edu.umd.cs.findbugs.plugin.eclipse_3.0.0.20140706/findbugs.png
+(So &lt;eclipse_install_dir&gt;/plugins/edu.umd.cs.findbugs.plugin.eclipse_3.0.1.20150306/findbugs.png
should be the path to the &FindBugs; logo.)
</para>
@@ -1854,14 +1864,6 @@ This section lists common problems with the plugin and (if known) how to resolve
<para>
Filter files may be used to include or exclude bug reports for particular classes
and methods. This chapter explains how to use filter files.
-
-<note>
-<title>Planned Features</title>
-<para>
- Filters are currently only supported by the Command Line interface.
- Eventually, filter support will be added to the GUI.
-</para>
-</note>
</para>
@@ -1984,7 +1986,7 @@ In other words, each of the children must be true for the predicate to be true.
<para>
This element matches warnings associated with a particular class. The
<literal>name</literal> attribute is used to specify the exact or regex match pattern
- for the class name.
+ for the class name. The <literal>role</literal> attribute is the class role.
</para>
<para>
@@ -2021,7 +2023,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 <literal>params</literal> attribute is a comma-separated list
of the types of the method's parameters. The <literal>returns</literal> attribute is
- the method's return type. In <literal>params</literal> and <literal>returns</literal>, class names
+ the method's return type. The <literal>role</literal> attribute is
+ the method role. In <literal>params</literal> and <literal>returns</literal>, 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 <literal>name</literal> attribute or <literal>params</literal>
@@ -2036,7 +2039,8 @@ In other words, each of the children must be true for the predicate to be true.
<listitem><para>This element specifies a field. The <literal>name</literal> 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 <literal>type</literal> 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 <literal>role</literal> attribute is
+ the field role.
</para></listitem>
</varlistentry>
@@ -3955,6 +3959,10 @@ and fixed a bug related to renaming the Eclipse plugin ID.</para>
<para>Dieter von Holten (dvholten) contributed
some German improvements to findbugs_de.properties.</para>
+<para>Kevin Lubick contributed fixes and tests for multi-quick-fixes and customizable
+annotation colors for Eclipse plugin.</para>
+
+<para>Tagir Valeev contributed several new bug detectors and improved existing ones.</para>
<para>If you have contributed to &FindBugs;, but aren't mentioned above,
please send email to <email>findbugs@cs.umd.edu</email> (and also accept
« no previous file with comments | « doc/mailingLists.html ('k') | doc/manual.xsl » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698