diff options
| author | Bradley Burns <56638814+bradb423@users.noreply.github.com> | 2022-01-22 20:14:23 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-01-22 12:14:23 -0800 |
| commit | cbe2e205dac99f20afff4ccdeca21fd10d596565 (patch) | |
| tree | 565406a74160d301741556397c43473e38459014 /doc/python-coverage.1.txt | |
| parent | 2cc2254581dad57719b155b4d349d4f6fdd65d2d (diff) | |
| download | python-coveragepy-git-cbe2e205dac99f20afff4ccdeca21fd10d596565.tar.gz | |
feat: add "lcov" command for generating LCOV reports
* Add LCOV functionality into coverage.py
* Add testing for the LCOV reporter
* Add documentation for the LCOV reporter
Diffstat (limited to 'doc/python-coverage.1.txt')
| -rw-r--r-- | doc/python-coverage.1.txt | 28 |
1 files changed, 28 insertions, 0 deletions
diff --git a/doc/python-coverage.1.txt b/doc/python-coverage.1.txt index bffc7072..41a3bbea 100644 --- a/doc/python-coverage.1.txt +++ b/doc/python-coverage.1.txt @@ -67,6 +67,9 @@ COMMAND OVERVIEW |command| **xml** Create an XML report of coverage results. +|command| **lcov** + Create an LCOV report of coverage results. + GLOBAL OPTIONS ============== @@ -229,6 +232,31 @@ COMMAND REFERENCE \--show-contexts Include information about the contexts that executed each line. +**lcov** [ `option` ... ] [ `MODULE` ... ] + + Create an LCOV report of the coverage results. + + Options: + + \--fail-under `MIN` + Exit with a status of 2 if the total coverage is less than `MIN`. + + \-i, --ignore-errors + Ignore errors while reading source files. + + \-o `OUTFILE` + Write the LCOV report to `OUTFILE`. Defaults to ``coverage.lcov``. + + \--include `PATTERN` [ , ... ] + Include only files whose paths match one of these + PATTERNs. Accepts shell-style wildcards, which must be quoted. + + \--omit `PATTERN` [ , ... ] + Omit files when their file name matches one of these PATTERNs. + Usually needs quoting on the command line. + + \-q, --quiet + Don't print messages about what is happening. **report** [ `option` ... ] [ `MODULE` ... ] |
