Skip to content

Commit f3fc338

Browse files
authored
[doc] Add --verify-json to dwarfdump documentation
1 parent 9fa55ec commit f3fc338

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
@@ -150,6 +150,12 @@ OPTIONS
150150
compile unit chains, DIE relationships graph, address
151151
ranges, and more.
152152

153+
.. option:: --verify-json=<path>
154+
155+
Output JSON-formatted error summary to the a file specfied by
156+
<path>. Implies :option:`--verify`. The output format is described
157+
in the section below (:ref:`verify-json-format`).
158+
153159
.. option:: --version
154160

155161
Display the version of the tool.
@@ -196,6 +202,28 @@ For aggregated values, the following keys are used:
196202
- `#variables - entry values ...` ==> the number of variables excluding
197203
the entry values etc.
198204

205+
.. _verify-json-format:
206+
207+
FORMAT OF VERIFY JSON OUTPUT
208+
----------------------------
209+
210+
The format of the JSON output created by the :option:`--verify-json=<path>` is::
211+
212+
{
213+
"error-categories": {
214+
"<first category description>": {"count": 1234},
215+
"<next category description>": {"count": 4321}
216+
},
217+
"error-count": 5555
218+
}
219+
220+
The following is generated if there are no errors reported::
221+
222+
{
223+
"error-categories": {},
224+
"error-count": 0
225+
}
226+
199227
EXIT STATUS
200228
-----------
201229

0 commit comments

Comments
 (0)