clang/www/analyzer/command-line.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
   2           "http://www.w3.org/TR/html4/strict.dtd">
   3 <html>
   4 <head>
   5   <title>Running the analyzer from the command line</title>
   6   <link type="text/css" rel="stylesheet" href="content.css">
   7   <link type="text/css" rel="stylesheet" href="menu.css">
   8   <script type="text/javascript" src="scripts/menu.js"></script>
   9 </head>
  10 <body>
  11
  12 <div id="page">
  13 <!--#include virtual="menu.html.incl"-->
  14 <div id="content">
  15
  16 <h1>Running the analyzer from the command line</h1>
  17
  18 <p> Static Analyzer is by design a GUI tool. Its purpose is to find buggy execution
  19 paths in the program, and such paths are very hard to comprehend by looking at
  20 a non-interactive standard output. It is possible, however, to invoke the
  21 Static Analyzer from the command line in order to obtain analysis results, and
  22 then later view them interactively in a graphical interface. The following
  23 tools are used commonly to run the analyzer from the command line. Both tools
  24 are wrapper scripts to drive the analysis and the underlying invocations of the
  25 Clang compiler:
  26 <ol>
  27   <li><a href="scan-build.html">Scan-Build</a>
  28     is an old and simple command-line tool that emits static analyzer warnings as HTML files while compiling your project. You can view the analysis results in your web browser.
  29   </li>
  30   <ul>
  31     <li>
  32       Useful for individual developers who simply want to view static analysis results at their desk, or in a very simple collaborative environment.
  33     </li>
  34     <li>
  35       Works on all major platforms (Windows, Linux, macOS) and is available as a package in many Linux distributions.
  36     </li>
  37     <li>
  38       Does not include support for cross-translation-unit analysis.
  39     </li>
  40   </ul>
  41   <li><a href="codechecker.html">CodeChecker</a>
  42      is a web server that runs the Static Analyzer on your projects on demand and maintains a database of issues.
  43   </li>
  44   <ul>
  45     <li>
  46       Perfect for managing large amounts of Static Analyzer warnings in a collaborative environment.
  47     </li>
  48     <li>
  49       Generally much more feature-rich than scan-build.
  50     </li>
  51     <li>Supports incremental analysis: Results can be stored in a database, subsequent analysis runs can be compared to list the newly added defects.</li>
  52     <li><a href="https://clang.llvm.org/docs/analyzer/user-docs/CrossTranslationUnit.html">Cross Translation Unit (CTU) analysis</a> is supported fully on Linux via CodeChecker.</li>
  53     <li>Can run clang-tidy checkers too.</li>
  54     <li>Open source, but out-of-tree, i.e. not part of the LLVM project.</li>
  55   </ul>
  56 </ol>
  57 </p>
  58
  59 <p>
  60 </p>
  61 <p>
  62 </p>
  63
  64 </div>
  65 </div>
  66 </body>
  67 </html>