[llvm] fcdb178 - [doc] Add --verify-json to dwarfdump documentation (#110909)

[via llvm-commits]

Author: bd1976bris
Date: 2024-10-04T10:14:45+01:00
New Revision: fcdb178bb477a7bd93048fa09a5ca6b1927bdb25

URL: https://github.com/llvm/llvm-project/commit/fcdb178bb477a7bd93048fa09a5ca6b1927bdb25
DIFF: https://github.com/llvm/llvm-project/commit/fcdb178bb477a7bd93048fa09a5ca6b1927bdb25.diff

LOG: [doc] Add --verify-json to dwarfdump documentation (#110909)

This adds documentation for --verify-json, see:
https://github.com/llvm/llvm-project/pull/81762

Added: 
    

Modified: 
    llvm/docs/CommandGuide/llvm-dwarfdump.rst

Removed: 
    


################################################################################
diff  --git a/llvm/docs/CommandGuide/llvm-dwarfdump.rst b/llvm/docs/CommandGuide/llvm-dwarfdump.rst
index 4c86b2cc351435..426a6d596a1b89 100644
--- a/llvm/docs/CommandGuide/llvm-dwarfdump.rst
+++ b/llvm/docs/CommandGuide/llvm-dwarfdump.rst
@@ -160,6 +160,12 @@ OPTIONS
             compile unit chains, DIE relationships graph, address
             ranges, and more.
 
+.. option:: --verify-json=<path>
+
+            Output JSON-formatted error summary to the a file specfied by
+            <path>. Implies :option:`--verify`.  The output format is described
+            in the section below (:ref:`verify-json-format`).
+
 .. option:: --version
 
             Display the version of the tool.
@@ -206,6 +212,28 @@ For aggregated values, the following keys are used:
       - `#variables - entry values ...` ==> the number of variables excluding
         the entry values etc.
 
+.. _verify-json-format:
+
+FORMAT OF VERIFY JSON OUTPUT
+----------------------------
+
+The format of the JSON output created by the :option:`--verify-json` is::
+
+  { 
+    "error-categories": { 
+      "<first category description>": {"count": 1234},
+      "<next category description>": {"count": 4321}
+    },
+    "error-count": 5555
+  }
+
+The following is generated if there are no errors reported::
+
+  { 
+    "error-categories": {},
+    "error-count": 0
+  }
+
 EXIT STATUS
 -----------