]> granicus.if.org Git - clang/commitdiff
More info on filing static analysis bug reports.
authorTed Kremenek <kremenek@apple.com>
Tue, 8 Jul 2008 21:25:35 +0000 (21:25 +0000)
committerTed Kremenek <kremenek@apple.com>
Tue, 8 Jul 2008 21:25:35 +0000 (21:25 +0000)
git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@53250 91177308-0d34-0410-b5e6-96231b3b80d8

www/StaticAnalysis.html
www/StaticAnalysisUsage.html

index 04e162089c372085ccc0a36d500e03804d8fb7b3..a53caaeb7d696a9f1e28d82f776bfce6ec21e754 100644 (file)
@@ -105,7 +105,7 @@ algorithms to reduce the amount of work it must do to find bugs.</li>
     <li><a href="StaticAnalysisUsage.html#Output">Output of the Analyzer</a></li>
     <li><a href="StaticAnalysisUsage.html#RecommendedUsageGuidelines">Recommended Usage Guidelines</a></li>
     <li><a href="StaticAnalysisUsage.html#Debugging">Debugging the Analyzer</a></li>
-    <li><a href="StaticAnalysisUsage.html#filingbugs">Filing Bugs</a></li>
+    <li><a href="StaticAnalysisUsage.html#filingbugs">Filing Bugs and Feature Requests</a></li>
   </ul>
 </div>
 
index 204d755c51e4359070a366bf04485a4b92322fad..aa52cfdcdf0db19c694cfcf86825e17ea8111dc9 100644 (file)
@@ -267,10 +267,23 @@ calling <tt>clang</tt>). <tt>ccc-analyzer</tt> tries to correctly forward all
 the arguments over to <tt>gcc</tt>, but this may not work perfectly (please
 report bugs of this kind).
 
-<h2 id="filingbugs">Filing Bugs</h2>
+<h2 id="filingbugs">Filing Bugs and Feature Requests</h2>
 
-<p>We encourage users to file bug reports for any problems that they
-encounter.</p>
+<p>We encourage users to file bug reports for any problems that they encounter.
+We also welcome feature requests. When filing a bug report, please do the
+following:</p>
+
+<ul>  
+
+<li>Include the checker build (for prebuilt Mac OS X binaries) or the SVN
+revision number.</li>
+
+<li>Provide a self-encapsulated, reduced test case that exhibits the issue
+  you are experiencing.</li>
+
+<li>Test cases don't tell us everything.  Please briefly describe the problem you are seeing.</li>
+
+</ul>
 
 <h3>Outside Apple</h3>