Skip to content

Commit

Permalink
Update help text in the README
Browse files Browse the repository at this point in the history
  • Loading branch information
@marco-c
marco-c committed Apr 2, 2023
1 parent a05ed8f commit 917494a
Showing 1 changed file with 112 additions and 80 deletions.
192 changes: 112 additions & 80 deletions README.md
View file
Expand Up @@ -37,120 +37,152 @@ This is a project initiated by Mozilla to gather code coverage results on Firefo
## man grcov

```text
USAGE:
grcov [FLAGS] [OPTIONS] <paths>...
Usage: grcov [OPTIONS] <PATHS>...
FLAGS:
--branch
Enables parsing branch coverage information
Arguments:
<PATHS>...
Sets the input paths to use
--guess-directory-when-missing
Options:
-b, --binary-path <PATH>
Sets the path to the compiled binary to be used
--llvm-path <PATH>
Sets the path to the LLVM bin directory
-h, --help
Prints help information
-t, --output-types <OUTPUT TYPE>
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.
--ignore-not-existing
Ignore source files that can't be found on the disk
--llvm
Speeds-up parsing, when the code coverage information is exclusively coming from a llvm build
[default: lcov]
--parallel
Sets the build type to be parallel for 'coveralls' and 'coveralls+' formats
-o, --output-path <PATH>
Specifies the output path. This is a file for a single output type and must be a folder
for multiple output types
-V, --version
Prints version information
--output-config-file <PATH>
Specifies the output config file
-s, --source-dir <DIRECTORY>
Specifies the root directory of the source files
OPTIONS:
-b, --binary-path <PATH>
Sets the path to the directory containing the compiled binaries to be used
-p, --prefix-dir <PATH>
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)
--commit-sha <COMMIT HASH>
Sets the hash of the commit used to generate the code coverage data
--ignore-not-existing
Ignore source files that can't be found on the disk
--excl-br-line <regex>
Lines in covered files containing this marker will be excluded from branch coverage.
--ignore <PATH>
Ignore files/directories specified as globs
--excl-br-start <regex>
Marks the beginning of a section excluded from branch coverage. The current line is part of this section.
--keep-only <PATH>
Keep only files/directories specified as globs
--excl-br-stop <regex>
Marks the end of a section excluded from branch coverage. The current line is part of this section.
--path-mapping <PATH>
--excl-line <regex>
Lines in covered files containing this marker will be excluded.
--excl-start <regex>
Marks the beginning of an excluded section. The current line is part of this section.
--branch
Enables parsing branch coverage information
--excl-stop <regex>
Marks the end of an excluded section. The current line is part of this section.
--filter <FILTER>
Filters out covered/uncovered files. Use 'covered' to only return covered files,
'uncovered' to only return uncovered files
--filter <filter>
Filters out covered/uncovered files. Use 'covered' to only return covered files, 'uncovered' to only return
uncovered files [possible values: covered, uncovered]
--ignore <PATH>...
Ignore files/directories specified as globs
[possible values: covered, uncovered]
--keep-only <PATH>...
Keep only files/directories specified as globs
--llvm
Speeds-up parsing, when the code coverage information is exclusively coming from a llvm
build
--log <LOG>
Set the file where to log (or stderr or stdout). Defaults to 'stderr' [default: stderr]
--token <TOKEN>
Sets the repository token from Coveralls, required for the 'coveralls' and 'coveralls+'
formats
--log-level <LEVEL>
Set the log level. [default: ERROR] [possible values: OFF, ERROR, WARN, INFO, DEBUG, TRACE]
--commit-sha <COMMIT HASH>
Sets the hash of the commit used to generate the code coverage data
-o, --output-path <PATH>
Specifies the output path
--service-name <SERVICE NAME>
Sets the service name
-t, --output-type <OUTPUT TYPE>
Sets a custom output type:
- *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;
- *cobertura* for a cobertura coverage report;
- *files* to only return a list of files.
[default: lcov] [possible values: ade, lcov, coveralls, coveralls+, files, covdir, html, cobertura]
--path-mapping <PATH>...
--service-number <SERVICE NUMBER>
Sets the service number
--service-job-id <SERVICE JOB ID>
Sets the service job id
-p, --prefix-dir <PATH>
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)
--service-job-id <SERVICE JOB ID>
Sets the service job id [aliases: service-job-number]
[aliases: service-job-number]
--service-name <SERVICE NAME>
Sets the service name
--service-pull-request <SERVICE PULL REQUEST>
Sets the service pull request number
--service-number <SERVICE NUMBER>
Sets the service number
--parallel
Sets the build type to be parallel for 'coveralls' and 'coveralls+' formats
--service-pull-request <SERVICE PULL REQUEST>
Sets the service pull request number
--threads <NUMBER>
-s, --source-dir <DIRECTORY>
Specifies the root directory of the source files
--threads <NUMBER>
[default: 11]
--precision <NUMBER>
Sets coverage decimal point precision on output reports
--token <TOKEN>
Sets the repository token from Coveralls, required for the 'coveralls' and 'coveralls+' formats
[default: 2]
--vcs-branch <VCS BRANCH>
Set the branch for coveralls report. Defaults to 'master' [default: master]
--guess-directory-when-missing
ARGS:
<paths>...
Sets the input paths to use
--vcs-branch <VCS BRANCH>
Set the branch for coveralls report. Defaults to 'master'
[default: master]
--log <LOG>
Set the file where to log (or stderr or stdout). Defaults to 'stderr'
[default: stderr]
--log-level <LEVEL>
Set the log level
[default: ERROR]
[possible values: OFF, ERROR, WARN, INFO, DEBUG, TRACE]
--excl-line <regex>
Lines in covered files containing this marker will be excluded
--excl-start <regex>
Marks the beginning of an excluded section. The current line is part of this section
--excl-stop <regex>
Marks the end of an excluded section. The current line is part of this section
--excl-br-line <regex>
Lines in covered files containing this marker will be excluded from branch coverage
--excl-br-start <regex>
Marks the beginning of a section excluded from branch coverage. The current line is part
of this section
--excl-br-stop <regex>
Marks the end of a section excluded from branch coverage. The current line is part of this
section
--no-demangle
No symbol demangling
-h, --help
Print help (see a summary with '-h')
-V, --version
Print version
```

## How to get grcov
Expand Down

0 comments on commit 917494a

Please sign in to comment.