summaryrefslogtreecommitdiff
path: root/doc/python-coverage.1.txt
diff options
context:
space:
mode:
authorNed Batchelder <ned@nedbatchelder.com>2022-01-25 09:28:41 -0500
committerNed Batchelder <ned@nedbatchelder.com>2022-01-25 09:28:41 -0500
commitbf8cbe1289ed42f51bf788fc86f7a8cee114c3e3 (patch)
tree62c8a349ba0371ca477e10ff64d86138a203390d /doc/python-coverage.1.txt
parentf9a5451f8923e4e7c87bf725760257da43346567 (diff)
downloadpython-coveragepy-git-bf8cbe1289ed42f51bf788fc86f7a8cee114c3e3.tar.gz
fix: more cleanup of --data-file options
Diffstat (limited to 'doc/python-coverage.1.txt')
-rw-r--r--doc/python-coverage.1.txt38
1 files changed, 37 insertions, 1 deletions
diff --git a/doc/python-coverage.1.txt b/doc/python-coverage.1.txt
index 41a3bbea..7cd16b8d 100644
--- a/doc/python-coverage.1.txt
+++ b/doc/python-coverage.1.txt
@@ -8,7 +8,7 @@ Measure Python code coverage
:Author: Ned Batchelder <ned@nedbatchelder.com>
:Author: |author|
-:Date: 2021-01-24
+:Date: 2022-01-25
:Copyright: Apache 2.0 license, attribution and disclaimer required.
:Manual section: 1
:Manual group: Coverage.py
@@ -96,6 +96,10 @@ COMMAND REFERENCE
\-d `DIR`, --directory=`DIR`
Write the output files to DIR.
+ \--data-file `INFILE`
+ Read coverage data for report generation from this
+ file. Defaults to '.coverage'.
+
\-i, --ignore-errors
Ignore errors while reading source files.
@@ -123,6 +127,9 @@ COMMAND REFERENCE
Append coverage data to .coverage, otherwise it starts clean each
time.
+ \--data-file `DATAFILE`
+ Base name of the data files to operate on. Defaults to '.coverage'.
+
\--keep
Keep original coverage data files.
@@ -145,6 +152,11 @@ COMMAND REFERENCE
Erase previously collected coverage data.
+ Options:
+
+ \--data-file `DATAFILE`
+ Base name of the data files to operate on. Defaults to '.coverage'.
+
**help** [ `command` ]
Describe how to use coverage.py.
@@ -163,6 +175,10 @@ COMMAND REFERENCE
\-d `DIR`, --directory `DIR`
Write the output files to `DIR`.
+ \--data-file `INFILE`
+ Read coverage data for report generation from this file.
+ Defaults to '.coverage'.
+
\--fail-under `MIN`
Exit with a status of 2 if the total coverage is less than `MIN`.
@@ -206,6 +222,10 @@ COMMAND REFERENCE
\--contexts `PAT` [ , ... ]
Only include contexts that match one of the regex patterns.
+ \--data-file `INFILE`
+ Read coverage data for report generation from this file.
+ Defaults to '.coverage'.
+
\--fail-under `MIN`
Exit with a status of 2 if the total coverage is less than `MIN`.
@@ -238,6 +258,10 @@ COMMAND REFERENCE
Options:
+ \--data-file `INFILE`
+ Read coverage data for report generation from this file.
+ Defaults to '.coverage'.
+
\--fail-under `MIN`
Exit with a status of 2 if the total coverage is less than `MIN`.
@@ -267,6 +291,10 @@ COMMAND REFERENCE
\--contexts `PAT` [ , ... ]
Only include contexts that match one of the regex patterns.
+ \--data-file `INFILE`
+ Read coverage data for report generation from this file.
+ Defaults to '.coverage'.
+
\--fail-under `MIN`
Exit with a status of 2 if the total coverage is less than `MIN`.
@@ -324,6 +352,10 @@ COMMAND REFERENCE
\--context `CONTEXT`
The context label to record for this coverage run.
+ \--data-file `OUTFILE`
+ Write the recorded coverage data to this file.
+ Defaults to '.coverage'.
+
\--include `PATTERN` [ , ... ]
Include only files whose paths match one of these
PATTERNs. Accepts shell-style wildcards, which must be quoted.
@@ -357,6 +389,10 @@ COMMAND REFERENCE
Options:
+ \--data-file `INFILE`
+ Read coverage data for report generation from this file.
+ Defaults to '.coverage'.
+
\--fail-under `MIN`
Exit with a status of 2 if the total coverage is less than `MIN`.