Skip to content

Commit fcdb178

Browse files
authored
[doc] Add --verify-json to dwarfdump documentation (#110909)
This adds documentation for --verify-json, see: #81762
1 parent 23c02a4 commit fcdb178

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

llvm/docs/CommandGuide/llvm-dwarfdump.rst

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -160,6 +160,12 @@ OPTIONS
160160
compile unit chains, DIE relationships graph, address
161161
ranges, and more.
162162

163+
.. option:: --verify-json=<path>
164+
165+
Output JSON-formatted error summary to the a file specfied by
166+
<path>. Implies :option:`--verify`. The output format is described
167+
in the section below (:ref:`verify-json-format`).
168+
163169
.. option:: --version
164170

165171
Display the version of the tool.
@@ -206,6 +212,28 @@ For aggregated values, the following keys are used:
206212
- `#variables - entry values ...` ==> the number of variables excluding
207213
the entry values etc.
208214

215+
.. _verify-json-format:
216+
217+
FORMAT OF VERIFY JSON OUTPUT
218+
----------------------------
219+
220+
The format of the JSON output created by the :option:`--verify-json` is::
221+
222+
{
223+
"error-categories": {
224+
"<first category description>": {"count": 1234},
225+
"<next category description>": {"count": 4321}
226+
},
227+
"error-count": 5555
228+
}
229+
230+
The following is generated if there are no errors reported::
231+
232+
{
233+
"error-categories": {},
234+
"error-count": 0
235+
}
236+
209237
EXIT STATUS
210238
-----------
211239

0 commit comments

Comments
 (0)