diff options
| author | Vedant Kumar <vsk@apple.com> | 2016-10-25 17:40:55 +0000 |
|---|---|---|
| committer | Vedant Kumar <vsk@apple.com> | 2016-10-25 17:40:55 +0000 |
| commit | d4998ec16b89c3e0363e27afabe9f0fa03f8b650 (patch) | |
| tree | bec3e2a6a6e6ef47068b6c688eef0e3daaf1ff2a /docs | |
| parent | 3089ab81dc5ed220462515a570b9f9c37291e155 (diff) | |
[llvm-cov] Add support for loading coverage from multiple objects
Differential Revision: https://reviews.llvm.org/D25086
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@285088 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/CommandGuide/llvm-cov.rst | 22 |
1 files changed, 11 insertions, 11 deletions
diff --git a/docs/CommandGuide/llvm-cov.rst b/docs/CommandGuide/llvm-cov.rst index 35424890f51..4c0354c0d60 100644 --- a/docs/CommandGuide/llvm-cov.rst +++ b/docs/CommandGuide/llvm-cov.rst @@ -167,14 +167,14 @@ SHOW COMMAND SYNOPSIS ^^^^^^^^ -:program:`llvm-cov show` [*options*] -instr-profile *PROFILE* *BIN* [*SOURCES*] +:program:`llvm-cov show` [*options*] -instr-profile *PROFILE* *BIN* [*-object BIN,...*] [[*-object BIN*]] [*SOURCES*] DESCRIPTION ^^^^^^^^^^^ -The :program:`llvm-cov show` command shows line by line coverage of a binary -*BIN* using the profile data *PROFILE*. It can optionally be filtered to only -show the coverage for the files listed in *SOURCES*. +The :program:`llvm-cov show` command shows line by line coverage of the +binaries *BIN*,... using the profile data *PROFILE*. It can optionally be +filtered to only show the coverage for the files listed in *SOURCES*. To use :program:`llvm-cov show`, you need a program that is compiled with instrumentation to emit profile and coverage data. To build such a program with @@ -183,7 +183,7 @@ flags. If linking with the ``clang`` driver, pass ``-fprofile-instr-generate`` to the link stage to make sure the necessary runtime libraries are linked in. The coverage information is stored in the built executable or library itself, -and this is what you should pass to :program:`llvm-cov show` as the *BIN* +and this is what you should pass to :program:`llvm-cov show` as a *BIN* argument. The profile data is generated by running this instrumented program normally. When the program exits it will write out a raw profile file, typically called ``default.profraw``, which can be converted to a format that @@ -292,14 +292,14 @@ REPORT COMMAND SYNOPSIS ^^^^^^^^ -:program:`llvm-cov report` [*options*] -instr-profile *PROFILE* *BIN* [*SOURCES*] +:program:`llvm-cov report` [*options*] -instr-profile *PROFILE* *BIN* [*-object BIN,...*] [[*-object BIN*]] [*SOURCES*] DESCRIPTION ^^^^^^^^^^^ -The :program:`llvm-cov report` command displays a summary of the coverage of a -binary *BIN* using the profile data *PROFILE*. It can optionally be filtered to -only show the coverage for the files listed in *SOURCES*. +The :program:`llvm-cov report` command displays a summary of the coverage of +the binaries *BIN*,... using the profile data *PROFILE*. It can optionally be +filtered to only show the coverage for the files listed in *SOURCES*. If no source files are provided, a summary line is printed for each file in the coverage data. If any files are provided, summaries are shown for each function @@ -332,13 +332,13 @@ EXPORT COMMAND SYNOPSIS ^^^^^^^^ -:program:`llvm-cov export` [*options*] -instr-profile *PROFILE* *BIN* +:program:`llvm-cov export` [*options*] -instr-profile *PROFILE* *BIN* [*-object BIN,...*] [[*-object 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 +and summaries of the coverage of the binaries *BIN*,... using the profile data *PROFILE* as JSON. For information on compiling programs for coverage and generating profile data, |