Home | History | Annotate | Download | only in doc
      1 <html>
      2 <head>
      3 <title>Reporting Bugs in FindBugs</title>
      4 <link rel="stylesheet" type="text/css" href="findbugs.css">
      5 
      6 </head>
      7 <body>
      8 
      9 <table width="100%"><tr>
     10 
     11 
     12 <td bgcolor="#b9b9fe" valign="top" align="left" width="20%"> 
     13 <table width="100%" cellspacing="0" border="0"> 
     14 <tr><td><a class="sidebar" href="index.html"><img src="umdFindbugs.png" alt="FindBugs"></a></td></tr> 
     15 
     16 <tr><td>&nbsp;</td></tr>
     17 
     18 <tr><td><b>Docs and Info</b></td></tr> 
     19 <tr><td><font size="-1"><a class="sidebar" href="findbugs2.html">FindBugs 2.0</a></font></td></tr> 
     20 <tr><td><font size="-1"><a class="sidebar" href="demo.html">Demo and data</a></font></td></tr> 
     21 <tr><td><font size="-1"><a class="sidebar" href="users.html">Users and supporters</a></font></td></tr> 
     22 <tr><td><font size="-1"><a class="sidebar" href="http://findbugs.blogspot.com/">FindBugs blog</a></font></td></tr> 
     23 <tr><td><font size="-1"><a class="sidebar" href="factSheet.html">Fact sheet</a></font></td></tr> 
     24 <tr><td><font size="-1"><a class="sidebar" href="manual/index.html">Manual</a></font></td></tr> 
     25 <tr><td><font size="-1"><a class="sidebar" href="ja/manual/index.html">Manual(ja/&#26085;&#26412;&#35486;)</a></font></td></tr> 
     26 <tr><td><font size="-1"><a class="sidebar" href="FAQ.html">FAQ</a></font></td></tr> 
     27 <tr><td><font size="-1"><a class="sidebar" href="bugDescriptions.html">Bug descriptions</a></font></td></tr> 
     28 <tr><td><font size="-1"><a class="sidebar" href="mailingLists.html">Mailing lists</a></font></td></tr> 
     29 <tr><td><font size="-1"><a class="sidebar" href="publications.html">Documents and Publications</a></font></td></tr> 
     30 <tr><td><font size="-1"><a class="sidebar" href="links.html">Links</a></font></td></tr> 
     31 
     32 <tr><td>&nbsp;</td></tr>
     33 
     34 <tr><td><a class="sidebar" href="downloads.html"><b>Downloads</b></a></td></tr> 
     35 
     36 <tr><td>&nbsp;</td></tr>
     37 
     38 <tr><td><a class="sidebar" href="http://www.cafeshops.com/findbugs"><b>FindBugs Swag</b></a></td></tr>
     39 
     40 <tr><td>&nbsp;</td></tr>
     41 
     42 <tr><td><b>Development</b></td></tr> 
     43 <tr><td><font size="-1"><a class="sidebar" href="http://sourceforge.net/tracker/?group_id=96405">Open bugs</a></font></td></tr> 
     44 <tr><td><font size="-1"><a class="sidebar" href="reportingBugs.html">Reporting bugs</a></font></td></tr> 
     45 <tr><td><font size="-1"><a class="sidebar" href="contributing.html">Contributing</a></font></td></tr> 
     46 <tr><td><font size="-1"><a class="sidebar" href="team.html">Dev team</a></font></td></tr> 
     47 <tr><td><font size="-1"><a class="sidebar" href="api/index.html">API</a> <a class="sidebar" href="api/overview-summary.html">[no frames]</a></font></td></tr> 
     48 <tr><td><font size="-1"><a class="sidebar" href="Changes.html">Change log</a></font></td></tr> 
     49 <tr><td><font size="-1"><a class="sidebar" href="http://sourceforge.net/projects/findbugs">SF project page</a></font></td></tr> 
     50 <tr><td><font size="-1"><a class="sidebar" href="http://code.google.com/p/findbugs/source/browse/">Browse source</a></font></td></tr> 
     51 <tr><td><font size="-1"><a class="sidebar" href="http://code.google.com/p/findbugs/source/list">Latest code changes</a></font></td></tr> 
     52 </table> 
     53 </td>
     54 
     55 <td align="left" valign="top">
     56 
     57 <h1>Reporting Bugs in FindBugs</h1>
     58 
     59 <p>
     60 First of all, if you find a bug in FindBugs, and have the
     61 skills to fix it, we encourage you to unleash the power of open source and
     62 <a href="contributing.html">send us a patch</a>.&nbsp; We will gladly
     63 credit you on our website and in the manual.
     64 </p>
     65 
     66 <p>
     67 Please report bugs using the
     68 <a href="http://sourceforge.net/tracker/?atid=614693&group_id=96405&func=browse">Sourceforge
     69 bugs tracker</a>.&nbsp; Note that you need to be logged in to sourceforge to
     70 use the bug tracker.
     71 </p>
     72 
     73 <p>
     74 If you cannot use the Sourceforge tracker, you can try sending 
     75 email to the <a href="http://www.cs.umd.edu/mailman/listinfo/findbugs-discuss"
     76 >findbugs-discuss mailing list</a>.&nbsp; You must be subscribed
     77 to the list to post a message.
     78 </p>
     79 
     80 <p>
     81 Finally, as a last resort, you can email <a href="mailto:findbugs (a] cs.umd.edu">findbugs (a] cs.umd.edu</a>.&nbsp;
     82 However, such emails are much less likely to be handled in a timely manner than
     83 posts to the tracker or mailing list.
     84 </p>
     85 	
     86 <h2>False and Inaccurate Warnings</h2>
     87 	
     88 <p>
     89 	Like most bug-detection tools based on static analysis, FindBugs
     90 	issues some warnings that do not correspond to real bugs.&nbsp;
     91 	While in general we would like to make the percentage of such warnings
     92 	small, we can never fully eliminate them.
     93 </p>
     94 
     95 <h2>Information to include</h2>
     96 
     97 <p>
     98 When reporting a bug, please include the following information:
     99 </p>
    100 <ul>
    101 <li>Complete list of steps to reproduce the problem</li>
    102 <li>If the error occurs during analysis, a jar file, class file,
    103     or self-contained Java class that demonstrates the problem</li>
    104 <li>FindBugs version</li>
    105 <li>JDK/JRE version</li>
    106 <li>Host operating system</li>
    107 <li>Any exception traces, Eclipse error log entries, etc. that might
    108     be relevant</li>
    109 </ul>
    110 
    111 
    112 <hr> <p> 
    113 <script language="JavaScript" type="text/javascript"> 
    114 <!---//hide script from old browsers 
    115 document.write( "Last updated "+ document.lastModified + "." ); 
    116 //end hiding contents ---> 
    117 </script> 
    118 <p> Send comments to <a class="sidebar" href="mailto:findbugs (a] cs.umd.edu">findbugs (a] cs.umd.edu</a> 
    119 <p> 
    120 <A href="http://sourceforge.net"><IMG src="http://sourceforge.net/sflogo.php?group_id=96405&type=5" width="210" height="62" border="0" alt="SourceForge.net Logo" /></A>
    121 
    122 </td>
    123 
    124 </tr></table>
    125 
    126 </body>
    127 </html>
    128