summaryrefslogtreecommitdiff
path: root/doc/help/debug.rst
diff options
context:
space:
mode:
Diffstat (limited to 'doc/help/debug.rst')
-rw-r--r--doc/help/debug.rst18
1 files changed, 18 insertions, 0 deletions
diff --git a/doc/help/debug.rst b/doc/help/debug.rst
new file mode 100644
index 00000000..7c71e90e
--- /dev/null
+++ b/doc/help/debug.rst
@@ -0,0 +1,18 @@
+
+.. code::
+
+ $ coverage debug --help
+ Usage: coverage debug <topic>
+
+ Display information about the internals of coverage.py, for diagnosing
+ problems. Topics are: 'data' to show a summary of the collected data; 'sys' to
+ show installation information; 'config' to show the configuration; 'premain'
+ to show what is calling coverage.
+
+ Options:
+ --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]
+