summaryrefslogtreecommitdiff
path: root/doc/help/json.rst
diff options
context:
space:
mode:
authorNed Batchelder <ned@nedbatchelder.com>2020-07-24 22:08:29 -0400
committerNed Batchelder <ned@nedbatchelder.com>2020-07-24 22:08:29 -0400
commit348aa47798d5d315c11d568eb87165b857d547e6 (patch)
tree7b433ee26291b6ecbc52327f665937147c89aa10 /doc/help/json.rst
parent5a30c8d82aa942ce882fda8dbf16f5ec6f9608c4 (diff)
downloadpython-coveragepy-git-348aa47798d5d315c11d568eb87165b857d547e6.tar.gz
Help in docs didn't work with tmp
Diffstat (limited to 'doc/help/json.rst')
-rw-r--r--doc/help/json.rst33
1 files changed, 33 insertions, 0 deletions
diff --git a/doc/help/json.rst b/doc/help/json.rst
new file mode 100644
index 00000000..4028788f
--- /dev/null
+++ b/doc/help/json.rst
@@ -0,0 +1,33 @@
+
+.. code::
+
+ $ coverage json --help
+ Usage: coverage json [options] [modules]
+
+ Generate a JSON report of coverage results.
+
+ Options:
+ --contexts=REGEX1,REGEX2,...
+ Only display data from lines covered in the given
+ contexts. Accepts Python regexes, which must be
+ quoted.
+ --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.
+ --include=PAT1,PAT2,...
+ Include only files whose paths match one of these
+ patterns. Accepts shell-style wildcards, which must be
+ quoted.
+ --omit=PAT1,PAT2,... Omit files whose paths match one of these patterns.
+ Accepts shell-style wildcards, which must be quoted.
+ -o OUTFILE Write the JSON report to this file. Defaults to
+ 'coverage.json'
+ --pretty-print Format the JSON for human readers.
+ --show-contexts Show contexts for covered lines.
+ --debug=OPTS Debug options, separated by commas. [env:
+ COVERAGE_DEBUG]
+ -h, --help Get help on this command.
+ --rcfile=RCFILE Specify configuration file. By default '.coveragerc',
+ 'setup.cfg', 'tox.ini', and 'pyproject.toml' are
+ tried. [env: COVERAGE_RCFILE]
+