From: Gabor Horvath <xazax.hun@gmail.com>
Date: Mon, 13 Nov 2017 11:13:02 +0000 (+0000)
Subject: [analyzer] Document the issue hash debugging facility
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=04d07cd0d09a87c4c28f76c592c5b928ad90d325;p=clang

[analyzer] Document the issue hash debugging facility

Differential Revision: https://reviews.llvm.org/D39543


git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@318030 91177308-0d34-0410-b5e6-96231b3b80d8
---

diff --git a/docs/analyzer/DebugChecks.rst b/docs/analyzer/DebugChecks.rst
index e2a8e05417..67521b82ca 100644
--- a/docs/analyzer/DebugChecks.rst
+++ b/docs/analyzer/DebugChecks.rst
@@ -242,6 +242,19 @@ ExprInspection checks
       clang_analyzer_printState(); // Read the stderr!
     }
 
+- ``void clang_analyzer_hashDump(int);``
+
+  The analyzer can generate a hash to identify reports. To debug what information
+  is used to calculate this hash it is possible to dump the hashed string as a
+  warning of an arbitrary expression using the function above.
+
+  Example usage::
+
+    void foo() {
+      int x = 1;
+      clang_analyzer_hashDump(x); // expected-warning{{hashed string for x}}
+    }
+
 Statistics
 ==========