Skip to content

Commit f579c7e

Browse files
committed
Update description of scan-build, mention scan-view
1 parent b962327 commit f579c7e

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

clang/docs/analyzer/user-docs/CommandLineUsage.rst

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,18 +16,19 @@ It is possible, however, to invoke the static analyzer from the command line in
1616
The following tools are used commonly to run the analyzer from the command line.
1717
Both tools are wrapper scripts to drive the analysis and the underlying invocations of the Clang compiler:
1818

19-
1. scan-build_ 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.
19+
1. scan-build_ 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; the utility script ``scan-view`` can provide a trivial HTTP server that servers these result files.
20+
- Is available as a part of the LLVM project (together with ``scan-view``).
2021
- Useful for individual developers who simply want to view static analysis results at their desk, or in a very simple collaborative environment.
2122
- Works on all major platforms (Windows, Linux, macOS) and is available as a package in many Linux distributions.
2223
- Does not include support for cross-translation-unit analysis.
2324

2425
2. CodeChecker_ is a driver and web server that runs the static analyzer on your projects on demand and maintains a database of issues.
26+
- Open source, but out-of-tree, i.e. not part of the LLVM project.
2527
- Perfect for managing large amounts of thee static analyzer warnings in a collaborative environment.
2628
- Generally much more feature-rich than scan-build.
2729
- Supports incremental analysis: Results can be stored in a database, subsequent analysis runs can be compared to list the newly added defects.
2830
- :doc:`CrossTranslationUnit` is supported fully on Linux via CodeChecker.
29-
- Can run clang-tidy checkers too.
30-
- Open source, but out-of-tree, i.e. not part of the LLVM project.
31+
- Can also run clang-tidy checks and various other analysis tools.
3132

3233
scan-build
3334
----------

0 commit comments

Comments
 (0)