diff options
| author | Ned Batchelder <ned@nedbatchelder.com> | 2013-10-06 08:49:56 -0400 |
|---|---|---|
| committer | Ned Batchelder <ned@nedbatchelder.com> | 2013-10-06 08:49:56 -0400 |
| commit | 9ff121cc1d3b5d90a585642fbba96961f1a249ab (patch) | |
| tree | 2b3ed393abcb6279ab4d1f833390cdc4cf7b58f5 /doc/cmd.rst | |
| parent | eb93c0b91e1c320f59885103b3f5d6dea149ae06 (diff) | |
| download | python-coveragepy-git-9ff121cc1d3b5d90a585642fbba96961f1a249ab.tar.gz | |
Document the --debug options.
Diffstat (limited to 'doc/cmd.rst')
| -rw-r--r-- | doc/cmd.rst | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/doc/cmd.rst b/doc/cmd.rst index 81a8fbe6..3572fff4 100644 --- a/doc/cmd.rst +++ b/doc/cmd.rst @@ -138,6 +138,24 @@ could affect the measurement process. The possible warnings include: This could be because you asked to measure only modules that never ran, or for other reasons. +.. _cmd_run_debug: + +The ``--debug`` option instructs coverage to log internal details of its +operation, to help with diagnosing problems. It takes a comma-separated list +of options, each indicating a facet of operation to log to stderr: + +* ``trace``: print every decision about whether to trace a file or not. For + files not being traced, the reason is also given. + +* ``config``: before starting, dump all the :ref:`configuration <config>` + values. + +* ``sys``: before starting, dump all the system and environment information, + as with :ref:`coverage debug sys <cmd_debug>`. + +* ``dataio``: log when reading or writing any data file. + +* ``pid``: annotate all debug output with the process id. .. _cmd_datafile: |