r318030 - [analyzer] Document the issue hash debugging facility

[Gabor Horvath via cfe-commits]

Author: xazax
Date: Mon Nov 13 03:13:02 2017
New Revision: 318030

URL: http://llvm.org/viewvc/llvm-project?rev=318030&view=rev
Log:
[analyzer] Document the issue hash debugging facility

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

Modified:
    cfe/trunk/docs/analyzer/DebugChecks.rst

Modified: cfe/trunk/docs/analyzer/DebugChecks.rst
URL: http://llvm.org/viewvc/llvm-project/cfe/trunk/docs/analyzer/DebugChecks.rst?rev=318030&r1=318029&r2=318030&view=diff
==============================================================================
--- cfe/trunk/docs/analyzer/DebugChecks.rst (original)
+++ cfe/trunk/docs/analyzer/DebugChecks.rst Mon Nov 13 03:13:02 2017
@@ -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
 ==========