summaryrefslogtreecommitdiffstats
path: root/clang/tools/scan-build-py/README.md
diff options
context:
space:
mode:
authorGabor Horvath <xazax.hun@gmail.com>2018-02-28 13:23:10 +0000
committerGabor Horvath <xazax.hun@gmail.com>2018-02-28 13:23:10 +0000
commiteb0584bee413c5b0f3275e47d6153433c8a3130f (patch)
treee9f412f0f0fe6c8a291bd02ecadaec4ccbd79b52 /clang/tools/scan-build-py/README.md
parent4529aac2de3ffccbf015503681bb5c9712e295b7 (diff)
downloadbcm5719-llvm-eb0584bee413c5b0f3275e47d6153433c8a3130f.tar.gz
bcm5719-llvm-eb0584bee413c5b0f3275e47d6153433c8a3130f.zip
[analyzer] Support for naive cross translation unit analysis
The aim of this patch is to be minimal to enable incremental development of the feature on the top of the tree. This patch should be an NFC when the feature is turned off. It is turned off by default and still considered as experimental. Technical details are available in the EuroLLVM Talk: http://llvm.org/devmtg/2017-03//2017/02/20/accepted-sessions.html#7 Note that the initial prototype was done by A. Sidorin et al.: http://lists.llvm.org/pipermail/cfe-dev/2015-October/045730.html Contributions to the measurements and the new version of the code: Peter Szecsi, Zoltan Gera, Daniel Krupp, Kareem Khazem. Differential Revision: https://reviews.llvm.org/D30691 llvm-svn: 326323
Diffstat (limited to 'clang/tools/scan-build-py/README.md')
-rw-r--r--clang/tools/scan-build-py/README.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/clang/tools/scan-build-py/README.md b/clang/tools/scan-build-py/README.md
index 54bfc37ff76..1b6fc488fa2 100644
--- a/clang/tools/scan-build-py/README.md
+++ b/clang/tools/scan-build-py/README.md
@@ -41,6 +41,32 @@ goes like this:
Use `--help` to know more about the commands.
+How to use the experimental Cross Translation Unit analysis
+-----------------------------------------------------------
+
+To run the CTU analysis, a compilation database file has to be created:
+
+ $ intercept-build <your build command>
+
+To run the Clang Static Analyzer against a compilation database
+with CTU analysis enabled, execute:
+
+ $ analyze-build --ctu
+
+For CTU analysis an additional (function-definition) collection-phase is required.
+For debugging purposes, it is possible to separately execute the collection
+and the analysis phase. By doing this, the intermediate files used for
+the analysis are kept on the disk in `./ctu-dir`.
+
+ # Collect and store the data required by the CTU analysis
+ $ analyze-build --ctu-collect-only
+
+ # Analyze using the previously collected data
+ $ analyze-build --ctu-analyze-only
+
+Use `--help` to get more information about the commands.
+
+
Limitations
-----------
OpenPOWER on IntegriCloud