summaryrefslogtreecommitdiff
path: root/doc/help/xml.rst
diff options
context:
space:
mode:
Diffstat (limited to 'doc/help/xml.rst')
-rw-r--r--doc/help/xml.rst28
1 files changed, 28 insertions, 0 deletions
diff --git a/doc/help/xml.rst b/doc/help/xml.rst
new file mode 100644
index 00000000..f83f297b
--- /dev/null
+++ b/doc/help/xml.rst
@@ -0,0 +1,28 @@
+
+.. code::
+
+ $ coverage xml --help
+ Usage: coverage xml [options] [modules]
+
+ Generate an XML report of 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.
+ --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 XML report to this file. Defaults to
+ 'coverage.xml'
+ --skip-empty Skip files with no code.
+ --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]
+