diff --git a/llvm/docs/CommandGuide/llvm-dwarfdump.rst b/llvm/docs/CommandGuide/llvm-dwarfdump.rst index 8adccf1c0c0a3..829f8a146b310 100644 --- a/llvm/docs/CommandGuide/llvm-dwarfdump.rst +++ b/llvm/docs/CommandGuide/llvm-dwarfdump.rst @@ -150,6 +150,12 @@ OPTIONS compile unit chains, DIE relationships graph, address ranges, and more. +.. option:: --verify-json= + + Output JSON-formatted error summary to the a file specfied by + . Implies :option:`--verify`. The output format is described + in the section below (:ref:`verify-json-format`). + .. option:: --version Display the version of the tool. @@ -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": { + "": {"count": 1234}, + "": {"count": 4321} + }, + "error-count": 5555 + } + +The following is generated if there are no errors reported:: + + { + "error-categories": {}, + "error-count": 0 + } + EXIT STATUS -----------