.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.49.3.
.TH GRCOV "1" "April 2024" "grcov 0.8.19" "User Commands"
.SH NAME
grcov \- grcov
.SH SYNOPSIS
.B grcov
[\fI\,OPTIONS\/\fR] \fI\,<PATHS>\/\fR...
.SH DESCRIPTION
grcov
Marco Castelluccio <mcastelluccio@mozilla.com>
Parse, collect and aggregate code coverage data for multiple source files
.SS "Arguments:"
.IP
<PATHS>...
.IP
Sets the input paths to use
.SH OPTIONS
.HP
\fB\-b\fR, \fB\-\-binary\-path\fR <PATH>
.IP
Sets the path to the compiled binary to be used
.HP
\fB\-\-llvm\-path\fR <PATH>
.IP
Sets the path to the LLVM bin directory
.HP
\fB\-t\fR, \fB\-\-output\-types\fR <OUTPUT TYPE>
.IP
Comma separated list of custom output types:
\- *html* for a HTML coverage report;
\- *coveralls* for the Coveralls specific format;
\- *lcov* for the lcov INFO format;
\- *covdir* for the covdir recursive JSON format;
\- *coveralls+* for the Coveralls specific format with function information;
\- *ade* for the ActiveData\-ETL specific format;
\- *files* to only return a list of files.
\- *markdown* for human easy read.
\- *cobertura* for output in cobertura format.
.IP
[default: lcov]
.HP
\fB\-o\fR, \fB\-\-output\-path\fR <PATH>
.IP
Specifies the output path. This is a file for a single output type and must be a folder
for multiple output types
.HP
\fB\-\-output\-config\-file\fR <PATH>
.IP
Specifies the output config file
.HP
\fB\-s\fR, \fB\-\-source\-dir\fR <DIRECTORY>
.IP
Specifies the root directory of the source files
.HP
\fB\-p\fR, \fB\-\-prefix\-dir\fR <PATH>
.IP
Specifies a prefix to remove from the paths (e.g. if grcov is run on a different machine
than the one that generated the code coverage information)
.HP
\fB\-\-ignore\-not\-existing\fR
.IP
Ignore source files that can't be found on the disk
.HP
\fB\-\-ignore\fR <PATH>
.IP
Ignore files/directories specified as globs
.HP
\fB\-\-keep\-only\fR <PATH>
.IP
Keep only files/directories specified as globs
.HP
\fB\-\-path\-mapping\fR <PATH>
.HP
\fB\-\-branch\fR
.IP
Enables parsing branch coverage information
.HP
\fB\-\-filter\fR <FILTER>
.IP
Filters out covered/uncovered files. Use 'covered' to only return covered files,
\&'uncovered' to only return uncovered files
.IP
[possible values: covered, uncovered]
.HP
\fB\-\-llvm\fR
.IP
Speeds\-up parsing, when the code coverage information is exclusively coming from a llvm
build
.HP
\fB\-\-token\fR <TOKEN>
.IP
Sets the repository token from Coveralls, required for the 'coveralls' and 'coveralls+'
formats
.HP
\fB\-\-commit\-sha\fR <COMMIT HASH>
.IP
Sets the hash of the commit used to generate the code coverage data
.HP
\fB\-\-service\-name\fR <SERVICE NAME>
.IP
Sets the service name
.HP
\fB\-\-service\-number\fR <SERVICE NUMBER>
.IP
Sets the service number
.HP
\fB\-\-service\-job\-id\fR <SERVICE JOB ID>
.IP
Sets the service job id
.IP
[aliases: service\-job\-number]
.HP
\fB\-\-service\-pull\-request\fR <SERVICE PULL REQUEST>
.IP
Sets the service pull request number
.HP
\fB\-\-service\-flag\-name\fR <SERVICE FLAG NAME>
.IP
Sets the service flag name for coveralls parallel/carryover mode
.HP
\fB\-\-parallel\fR
.IP
Sets the build type to be parallel for 'coveralls' and 'coveralls+' formats
.HP
\fB\-\-threads\fR <NUMBER>
.HP
\fB\-\-precision\fR <NUMBER>
.IP
Sets coverage decimal point precision on output reports
.IP
[default: 2]
.HP
\fB\-\-guess\-directory\-when\-missing\fR
.HP
\fB\-\-vcs\-branch\fR <VCS BRANCH>
.IP
Set the branch for coveralls report. Defaults to 'master'
.IP
[default: master]
.HP
\fB\-\-log\fR <LOG>
.IP
Set the file where to log (or stderr or stdout). Defaults to 'stderr'
.IP
[default: stderr]
.HP
\fB\-\-log\-level\fR <LEVEL>
.IP
Set the log level
.IP
[default: ERROR]
[possible values: OFF, ERROR, WARN, INFO, DEBUG, TRACE]
.HP
\fB\-\-excl\-line\fR <regex>
.IP
Lines in covered files containing this marker will be excluded
.HP
\fB\-\-excl\-start\fR <regex>
.IP
Marks the beginning of an excluded section. The current line is part of this section
.HP
\fB\-\-excl\-stop\fR <regex>
.IP
Marks the end of an excluded section. The current line is part of this section
.HP
\fB\-\-excl\-br\-line\fR <regex>
.IP
Lines in covered files containing this marker will be excluded from branch coverage
.HP
\fB\-\-excl\-br\-start\fR <regex>
.IP
Marks the beginning of a section excluded from branch coverage. The current line is part
of this section
.HP
\fB\-\-excl\-br\-stop\fR <regex>
.IP
Marks the end of a section excluded from branch coverage. The current line is part of this
section
.HP
\fB\-\-no\-demangle\fR
.IP
No symbol demangling
.HP
\fB\-h\fR, \fB\-\-help\fR
.IP
Print help (see a summary with '\-h')
.HP
\fB\-V\fR, \fB\-\-version\fR
.IP
Print version