Document the ‘debug’ sub-command.
authorBen Finney <[email protected]>
Tue, 12 Jul 2016 09:59:32 +0000 (12 19:59 +1000)
committerBen Finney <[email protected]>
Tue, 12 Jul 2016 10:09:48 +0000 (12 20:09 +1000)
debian/changelog
debian/python-coverage.1.txt

index 53e5c30..79e51af 100644 (file)
@@ -3,6 +3,7 @@ python-coverage (4.1+dfsg.1-3) UNRELEASED; urgency=medium
   * debian/python-coverage.1.txt:
     * Remove mention of “classic” command line arguments.
       Closes: bug#829556. Thanks to Jakub Wilk for the bug report.
+    * Correctly document the ‘debug’ sub-command.
 
  --
 
index c300035..141296e 100644 (file)
@@ -42,6 +42,10 @@ COMMAND OVERVIEW
 |command| **combine**
     Combine a number of data files.
 
+|command| **debug**
+    Display diagnostic information about the internals of this
+    program.
+
 |command| **erase**
     Erase previously collected coverage data.
 
@@ -98,6 +102,16 @@ COMMAND REFERENCE
     The combined results are written to a single file representing the
     union of the data.
 
+**debug** `topic`
+
+    Display information on the internals of coverage.py, for
+    diagnosing problems.
+
+    Topics are:
+
+    * `data`, to show a summary of the collected data.
+    * `sys`, to show installation information.
+
 **erase**
 
     Erase previously collected coverage data.