Skip to content

[doc] Add --verify-json to dwarfdump documentation #110909

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions llvm/docs/CommandGuide/llvm-dwarfdump.rst
Original file line number Diff line number Diff line change
Expand Up @@ -150,6 +150,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.
Expand Down Expand Up @@ -196,6 +202,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
-----------

Expand Down
Loading