[cfe-commits] r52221 - /cfe/trunk/www/StaticAnalysis.html

[Ted Kremenek]

Author: kremenek
Date: Wed Jun 11 11:09:34 2008
New Revision: 52221

URL: http://llvm.org/viewvc/llvm-project?rev=52221&view=rev
Log:
Added a disclaimer about running time, and provided an executive summary of the tool's interface.

Modified:
    cfe/trunk/www/StaticAnalysis.html

Modified: cfe/trunk/www/StaticAnalysis.html
URL: http://llvm.org/viewvc/llvm-project/cfe/trunk/www/StaticAnalysis.html?rev=52221&r1=52220&r2=52221&view=diff

==============================================================================
--- cfe/trunk/www/StaticAnalysis.html (original)
+++ cfe/trunk/www/StaticAnalysis.html Wed Jun 11 11:09:34 2008
@@ -36,7 +36,25 @@
 <b>many planned enhancements</b> to improve both the precision and scope of its
 analysis algorithms as well as the kinds bugs it will find.</p>
 
-<p>This document is arranged into the following sections:</p>
+<h3>High-Level Summary</h3>
+
+<p>Currently the analyzer is invoked as a command-line tool. It is intended to
+run in synchronous with a build of a project or code base. Analysis results are
+deposited in a directory as HTML files, which can then viewed using a web
+browser.</p>
+
+<p>The analyzer performs a variety of checks on code, each requiring different
+levels of analysis precision (more precision = more CPU time). While the
+analyzer is being designed to be as fast and light-weight as possible, please
+<b>do not expect it to be as fast as compiling a program</b> (even with
+optimizations enabled). Some of the algorithms needed to find bugs require in
+the worst case exponential time. The analyzer runs in a reasonable amount of
+time by both bounding the amount of checking work it will do as well as using
+clever algorithms to reduce the amount of work it must do to find bugs.</p>
+
+<h3>Organization</h3>
+
+<p>This page is arranged into the following sections:</p>
 
 <ul>
   <li><a href="#Contents">Obtaining the Analyzer</a></li>