[PATCH] D39543: [analyzer] Document the issue hash debugging facility

[Gábor Horváth via Phabricator via cfe-commits]

xazax.hun created this revision.
Herald added subscribers: szepet, baloghadamsoftware, whisperity.

Add documentation to the recently added issue hash dumping function.


Repository:
  rL LLVM

https://reviews.llvm.org/D39543

Files:
  docs/analyzer/DebugChecks.rst


Index: docs/analyzer/DebugChecks.rst
===================================================================
--- docs/analyzer/DebugChecks.rst
+++ docs/analyzer/DebugChecks.rst
@@ -242,6 +242,19 @@
       clang_analyzer_printState(); // Read the stderr!
     }
 
+- ``void clang_analyzer_hashDump(int);``
+
+  The analyzer can generate a hash to identify repots. To debug what 
information
+  is used to calculate this hash it is possible to dump the hashed string to
+  the stderr of an arbitrary expression using the function above.
+
+  Example usage::
+
+    void foo() {
+      int x = 1;
+      clang_analyzer_hashDump(x); // Hashed string of x on stderr.
+    }
+
 Statistics
 ==========
 



Index: docs/analyzer/DebugChecks.rst
===================================================================
--- docs/analyzer/DebugChecks.rst
+++ docs/analyzer/DebugChecks.rst
@@ -242,6 +242,19 @@
       clang_analyzer_printState(); // Read the stderr!
     }
 
+- ``void clang_analyzer_hashDump(int);``
+
+  The analyzer can generate a hash to identify repots. To debug what information
+  is used to calculate this hash it is possible to dump the hashed string to
+  the stderr of an arbitrary expression using the function above.
+
+  Example usage::
+
+    void foo() {
+      int x = 1;
+      clang_analyzer_hashDump(x); // Hashed string of x on stderr.
+    }
+
 Statistics
 ==========
 

_______________________________________________
cfe-commits mailing list
cfe-commits@lists.llvm.org
http://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits