Skip to content

Commit

Permalink
Add 'coverage debug' to help
Browse files Browse the repository at this point in the history
  • Loading branch information
nedbat committed Jul 5, 2020
1 parent 29538d9 commit c1c1c6c
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 2 deletions.
5 changes: 3 additions & 2 deletions coverage/cmdline.py
Original file line number Diff line number Diff line change
Expand Up @@ -349,13 +349,13 @@ def get_prog_name(self):
"debug", GLOBAL_ARGS,
usage="<topic>",
description=(
"Display information on the internals of coverage.py, "
"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; "
"or 'premain' to show what is calling coverage."
"'premain' to show what is calling coverage."
),
),

Expand Down Expand Up @@ -831,6 +831,7 @@ def unglob_args(args):
Commands:
annotate Annotate source files with execution information.
combine Combine a number of data files.
debug Display information about the internals of coverage.py
erase Erase previously collected coverage data.
help Get help on using coverage.py.
html Create an HTML report.
Expand Down
15 changes: 15 additions & 0 deletions doc/python-coverage.1.txt
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,9 @@ COMMAND OVERVIEW
|command| **combine**
Combine a number of data files.

|command| **debug**
Display information about the internals of coverage.py.

|command| **erase**
Erase previously collected coverage data.

Expand Down Expand Up @@ -116,6 +119,18 @@ COMMAND REFERENCE
Append coverage data to .coverage, otherwise it starts clean each
time.

**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.

**erase**

Erase previously collected coverage data.
Expand Down

0 comments on commit c1c1c6c

Please sign in to comment.