diff options
Diffstat (limited to 'llvm/docs')
| -rw-r--r-- | llvm/docs/CommandGuide/llvm-cov.rst | 22 | ||||
| -rw-r--r-- | llvm/docs/ReleaseNotes.rst | 3 |
2 files changed, 19 insertions, 6 deletions
diff --git a/llvm/docs/CommandGuide/llvm-cov.rst b/llvm/docs/CommandGuide/llvm-cov.rst index 6f1b6e46c48..71924e997d9 100644 --- a/llvm/docs/CommandGuide/llvm-cov.rst +++ b/llvm/docs/CommandGuide/llvm-cov.rst @@ -374,9 +374,15 @@ SYNOPSIS DESCRIPTION ^^^^^^^^^^^ -The :program:`llvm-cov export` command exports regions, functions, expansions, -and summaries of the coverage of the binaries *BIN*,... using the profile data -*PROFILE* as JSON. It can optionally be filtered to only export the coverage +The :program:`llvm-cov export` command exports coverage data of the binaries +*BIN*,... using the profile data *PROFILE* in either JSON or lcov trace file +format. + +When exporting JSON, the regions, functions, expansions, and summaries of the +coverage data will be exported. When exporting an lcov trace file, the +line-based coverage and summaries will be exported. + +The exported data can optionally be filtered to only export the coverage for the files listed in *SOURCES*. For information on compiling programs for coverage and generating profile data, @@ -392,12 +398,18 @@ OPTIONS universal binary or to use an architecture that does not match a non-universal binary. +.. option:: -format=<FORMAT> + + Use the specified output format. The supported formats are: "text" (JSON), + "lcov". + .. option:: -summary-only Export only summary information for each file in the coverage data. This mode will not export coverage information for smaller units such as individual - functions or regions. The result will be the same as produced by :program: - `llvm-cov report` command, but presented in JSON format rather than text. + functions or regions. The result will contain the same information as produced + by the :program:`llvm-cov report` command, but presented in JSON or lcov + format rather than text. .. option:: -ignore-filename-regex=<PATTERN> diff --git a/llvm/docs/ReleaseNotes.rst b/llvm/docs/ReleaseNotes.rst index 0da765a3027..a3500ba3f74 100644 --- a/llvm/docs/ReleaseNotes.rst +++ b/llvm/docs/ReleaseNotes.rst @@ -40,7 +40,8 @@ Non-comprehensive list of changes in this release functionality, or simply have a lot to talk about), see the `NOTE` below for adding a new subsection. -* Note.. +* The **llvm-cov** tool can now export lcov trace files using the + `-format=lcov` option of the `export` command. .. NOTE If you would like to document a larger change, then you can add a |
