summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTed Kremenek <kremenek@apple.com>2008-06-11 16:09:34 +0000
committerTed Kremenek <kremenek@apple.com>2008-06-11 16:09:34 +0000
commit690f46fd20e885328eadf86795ba97d4dccdbe33 (patch)
treeb77973b5318fb45f6984a8e69fa3624c23a33cb1
parenta612cac935a03e30af4d8611699da9c7ea27b351 (diff)
downloadbcm5719-llvm-690f46fd20e885328eadf86795ba97d4dccdbe33.tar.gz
bcm5719-llvm-690f46fd20e885328eadf86795ba97d4dccdbe33.zip
Added a disclaimer about running time, and provided an executive summary of the tool's interface.
llvm-svn: 52221
-rw-r--r--clang/www/StaticAnalysis.html20
1 files changed, 19 insertions, 1 deletions
diff --git a/clang/www/StaticAnalysis.html b/clang/www/StaticAnalysis.html
index 03dff7ac86b..f74e735b131 100644
--- a/clang/www/StaticAnalysis.html
+++ b/clang/www/StaticAnalysis.html
@@ -36,7 +36,25 @@ find bugs in C and Objective-C programs.</p>
<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>
OpenPOWER on IntegriCloud