Lines Matching +full:data +full:- +full:only

4 .nr rst2man-indent-level 0
7 \\$1 \\n[an-margin]
8 level \\n[rst2man-indent-level]
9 level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
10 -
11 \\n[rst2man-indent0]
12 \\n[rst2man-indent1]
13 \\n[rst2man-indent2]
18 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
19 . nr rst2man-indent-level +1
24 .\" indent \\n[an-margin]
25 .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
26 .nr rst2man-indent-level -1
27 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
30 .TH "LLVM-COV" "1" "2023-05-24" "16" "LLVM"
32 llvm-cov \- emit coverage information
35 \fBllvm\-cov\fP \fIcommand\fP [\fIargs...\fP]
38 The \fBllvm\-cov\fP tool shows code coverage information for
39 programs that are instrumented to emit profile data. It can be used to
40 work with \fBgcov\fP\-style coverage or with \fBclang\fP\(aqs instrumentation
44 the \fBllvm\-cov gcov\fP command were called. Otherwise, a command should
60 \fBllvm\-cov gcov\fP [\fIoptions\fP] \fISOURCEFILE\fP
63 The \fBllvm\-cov gcov\fP tool reads code coverage data files and displays
68 To use \fBllvm\-cov gcov\fP, you must first build an instrumented version
69 of your application that collects coverage data as it runs. Compile with the
70 \fB\-fprofile\-arcs\fP and \fB\-ftest\-coverage\fP options to add the
71 instrumentation. (Alternatively, you can use the \fB\-\-coverage\fP option, which
74 At the time you compile the instrumented code, a \fB\&.gcno\fP data file will be
76 coverage data. The other half of the data comes from \fB\&.gcda\fP files that are
91 where \fBllvm\-cov gcov\fP expects to find them.
93 Once you have generated the coverage data files, run \fBllvm\-cov gcov\fP
102 count is shown as \fB\-\fP if a line does not contain any executable code. If
108 .B \-a, \-\-all\-blocks
110 source code, this option causes llvm\-cov to show the count for each block
115 .B \-b, \-\-branch\-probabilities
120 .B \-c, \-\-branch\-counts
121 Display branch counts instead of probabilities (requires \-b).
125 .B \-m, \-\-demangled\-names
130 .B \-f, \-\-function\-summaries
136 .B \-\-help
137 Display available options (\-\-help\-hidden for more).
141 .B \-l, \-\-long\-file\-names
144 can be combined with the \-\-preserve\-paths option to use complete paths for
149 .B \-n, \-\-no\-output
155 .B \-o <DIR|FILE>, \-\-object\-directory=<DIR>, \-\-object\-file=<FILE>
157 object file, the coverage data files are expected to have the same base name
164 .B \-p, \-\-preserve\-paths
169 the \-\-long\-file\-names option, this applies to both the main file name and the
174 .B \-r
175 Only dump files with relative paths or absolute paths with the prefix specified
176 by \fB\-s\fP\&.
180 .B \-s <string>
185 .B \-t, \-\-stdout
190 .B \-u, \-\-unconditional\-branches
191 Include unconditional branches in the output for the \-\-branch\-probabilities
196 .B \-version
197 Display the version of llvm\-cov.
201 .B \-x, \-\-hash\-filenames
207 \fBllvm\-cov gcov\fP returns 1 if it cannot read input files.  Otherwise,
212 \fBllvm\-cov show\fP [\fIoptions\fP] \-instr\-profile \fIPROFILE\fP [\fIBIN\fP] [\fI\-object BIN\fP…
215 The \fBllvm\-cov show\fP command shows line by line coverage of the
216 binaries \fIBIN\fP\&...  using the profile data \fIPROFILE\fP\&. It can optionally be
217 filtered to only show the coverage for the files listed in \fISOURCE\fP\&....
222 To use \fBllvm\-cov show\fP, you need a program that is compiled with
223 instrumentation to emit profile and coverage data. To build such a program with
224 \fBclang\fP use the \fB\-fprofile\-instr\-generate\fP and \fB\-fcoverage\-mapping\fP
225 flags. If linking with the \fBclang\fP driver, pass \fB\-fprofile\-instr\-generate\fP
229 and this is what you should pass to \fBllvm\-cov show\fP as a \fIBIN\fP
230 argument. The profile data is generated by running this instrumented program
233 is suitable for the \fIPROFILE\fP argument using the \fBllvm\-profdata merge\fP
238 .B \-show\-branches=<VIEW>
244 .B \-show\-line\-counts
246 \fB\-show\fP option is used.
250 .B \-show\-expansions
256 .B \-show\-instantiations
263 .B \-show\-regions
269 .B \-show\-line\-counts\-or\-regions
270 Show the execution counts for each line if there is only one region on the
276 .B \-use\-color
281 .B \-arch=[*NAMES*]
286 architecture that does not match a non\-universal binary.
290 .B \-name=<NAME>
291 Show code coverage only for functions with the given name.
295 .B \-name\-allowlist=<FILE>
296 Show code coverage only for functions listed in the given file. Each line in
302 .B \-name\-regex=<PATTERN>
303 Show code coverage only for functions that match the given regular expression.
307 .B \-ignore\-filename\-regex=<PATTERN>
312 .B \-format=<FORMAT>
317 .B \-tab\-size=<TABSIZE>
319 only supported for the html format.
323 .B \-output\-dir=PATH
325 exist, it is created. When used in function view mode (i.e when \-name or
326 \-name\-regex are used to select specific functions), the report is written to
332 .B \-Xdemangler=<TOOL>|<TOOL\-OPTION>
334 human\-readable. This option can be specified multiple times to supply
335 arguments to the demangler (e.g \fI\-Xdemangler c++filt \-Xdemangler \-n\fP for C++).
336 The demangler is expected to read a newline\-separated list of symbols from
337 stdin and write a newline\-separated list of the same length to stdout.
341 .B \-num\-threads=N, \-j=N
342 Use N threads to write file reports (only applicable when \-output\-dir is
343 specified). When N=0, llvm\-cov auto\-detects an appropriate number of threads to
348 .B \-compilation\-dir=<dir>
349 Directory used as a base for relative coverage mapping paths. Only applicable
350 when binaries have been compiled with one of \fI\-fcoverage\-prefix\-map\fP
351 \fI\-fcoverage\-compilation\-dir\fP, or \fI\-ffile\-compilation\-dir\fP\&.
355 .B \-line\-coverage\-gt=<N>
356 Show code coverage only for functions with line coverage greater than the
361 .B \-line\-coverage\-lt=<N>
362 Show code coverage only for functions with line coverage less than the given
367 .B \-region\-coverage\-gt=<N>
368 Show code coverage only for functions with region coverage greater than the
373 .B \-region\-coverage\-lt=<N>
374 Show code coverage only for functions with region coverage less than the given
379 .B \-path\-equivalence=<from>,<to>
380 Map the paths in the coverage data to local source file paths. This allows you
381 to generate the coverage data on one machine, and then use llvm\-cov on a
386 .B \-coverage\-watermark=<high>,<low>
390 low should be between 0\-100 and high > low.
394 .B \-debuginfod
402 .B \-debug\-file\-directory=<dir>
410 \fBllvm\-cov report\fP [\fIoptions\fP] \-instr\-profile \fIPROFILE\fP [\fIBIN\fP] [\fI\-object BIN\…
413 The \fBllvm\-cov report\fP command displays a summary of the coverage of
414 the binaries \fIBIN\fP\&... using the profile data \fIPROFILE\fP\&. It can optionally be
415 filtered to only show the coverage for the files listed in \fISOURCE\fP\&....
421 coverage data. If any files are provided, summaries can be shown for each
422 function in the listed files if the \fB\-show\-functions\fP option is enabled.
424 For information on compiling programs for coverage and generating profile data,
429 .B \-use\-color[=VALUE]
434 .B \-arch=<name>
438 non\-universal binary.
442 .B \-show\-region\-summary
447 .B \-show\-branch\-summary
452 .B \-show\-functions
457 .B \-show\-instantiation\-summary
462 .B \-ignore\-filename\-regex=<PATTERN>
467 .B \-compilation\-dir=<dir>
468 Directory used as a base for relative coverage mapping paths. Only applicable
469 when binaries have been compiled with one of \fI\-fcoverage\-prefix\-map\fP
470 \fI\-fcoverage\-compilation\-dir\fP, or \fI\-ffile\-compilation\-dir\fP\&.
474 .B \-debuginfod
483 .B \-debug\-file\-directory=<dir>
491 \fBllvm\-cov export\fP [\fIoptions\fP] \-instr\-profile \fIPROFILE\fP [\fIBIN\fP] [\fI\-object BIN\…
494 The \fBllvm\-cov export\fP command exports coverage data of the binaries
495 \fIBIN\fP\&... using the profile data \fIPROFILE\fP in either JSON or lcov trace file
499 summaries of the coverage data will be exported. When exporting an lcov trace
500 file, the line\-based coverage, branch coverage, and summaries will be exported.
502 The exported data can optionally be filtered to only export the coverage
505 For information on compiling programs for coverage and generating profile data,
510 .B \-arch=<name>
514 non\-universal binary.
518 .B \-format=<FORMAT>
524 .B \-summary\-only
525 Export only summary information for each file in the coverage data. This mode
528 by the \fBllvm\-cov report\fP command, but presented in JSON or lcov
533 .B \-ignore\-filename\-regex=<PATTERN>
537 .B \-skip\-expansions
540 Skip exporting macro expansion coverage data.
543 .B \-skip\-functions
546 Skip exporting per\-function coverage data.
549 .B \-num\-threads=N, \-j=N
552 Use N threads to export coverage data. When N=0, llvm\-cov auto\-detects an
557 .B \-compilation\-dir=<dir>
558 Directory used as a base for relative coverage mapping paths. Only applicable
559 when binaries have been compiled with one of \fI\-fcoverage\-prefix\-map\fP
560 \fI\-fcoverage\-compilation\-dir\fP, or \fI\-ffile\-compilation\-dir\fP\&.
564 .B \-debuginfod
573 .B \-debug\-file\-directory=<dir>
581 2003-2023, LLVM Project