diff options
author | Vedant Kumar <vsk@apple.com> | 2016-07-26 22:50:58 +0000 |
---|---|---|
committer | Vedant Kumar <vsk@apple.com> | 2016-07-26 22:50:58 +0000 |
commit | 53397d1544fc15fb2d455fa2271df5eec3289d94 (patch) | |
tree | 76eadcd6ce5d1cfbea9fdc30741941b0404a6366 /docs/CommandGuide | |
parent | aaba6ed8cd69463b362a9d3672ba68d1c4419129 (diff) |
Retry: [llvm-cov] Add support for exporting coverage data to JSON
This enables users to export coverage information as portable JSON for use by
analysis tools and storage in document based databases.
The export sub-command is invoked just like the others:
llvm-cov export -instr-profile path/to/foo.profdata path/to/foo.binary
The resulting JSON contains a list of files and functions. Every file object
contains a list of segments, expansions, and a summary of the file's region,
function, and line coverage. Every function object contains the function's name
and regions. There is also a total summary for the entire object file.
Changes since the initial commit (r276813):
- Fixed the regexes in the tests to handle Windows filepaths.
Patch by Eddie Hurtig!
Differential Revision: https://reviews.llvm.org/D22651
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@276818 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'docs/CommandGuide')
-rw-r--r-- | docs/CommandGuide/llvm-cov.rst | 29 |
1 files changed, 29 insertions, 0 deletions
diff --git a/docs/CommandGuide/llvm-cov.rst b/docs/CommandGuide/llvm-cov.rst index 946b125a4529..665dbcd2113a 100644 --- a/docs/CommandGuide/llvm-cov.rst +++ b/docs/CommandGuide/llvm-cov.rst @@ -24,6 +24,7 @@ COMMANDS * :ref:`gcov <llvm-cov-gcov>` * :ref:`show <llvm-cov-show>` * :ref:`report <llvm-cov-report>` +* :ref:`export <llvm-cov-export>` .. program:: llvm-cov gcov @@ -315,3 +316,31 @@ OPTIONS It is an error to specify an architecture that is not included in the universal binary or to use an architecture that does not match a non-universal binary. + +EXPORT COMMAND +-------------- + +SYNOPSIS +^^^^^^^^ + +:program:`llvm-cov export` [*options*] -instr-profile *PROFILE* *BIN* + +DESCRIPTION +^^^^^^^^^^^ + +The :program:`llvm-cov export` command exports regions, functions, expansions, +and summaries of the coverage of a binary *BIN* using the profile data +*PROFILE* as JSON. + +For information on compiling programs for coverage and generating profile data, +see :ref:`llvm-cov-show`. + +OPTIONS +^^^^^^^ + +.. option:: -arch=<name> + + If the covered binary is a universal binary, select the architecture to use. + It is an error to specify an architecture that is not included in the + universal binary or to use an architecture that does not match a + non-universal binary. |