diff options
| author | Ned Batchelder <ned@nedbatchelder.com> | 2023-01-22 07:29:47 -0500 |
|---|---|---|
| committer | Ned Batchelder <ned@nedbatchelder.com> | 2023-01-22 07:29:47 -0500 |
| commit | c51ac463f07e31c87b20f50bd7e6445e4e4e83a2 (patch) | |
| tree | f873435d58754c74c00864bc5ed5c87c8a021e74 /doc/cmd.rst | |
| parent | 82c263814e57e1d790cbe1c00bd1c724b9ca8e3c (diff) | |
| download | python-coveragepy-git-c51ac463f07e31c87b20f50bd7e6445e4e4e83a2.tar.gz | |
docs: explain how to use ``--debug=trace``
Diffstat (limited to 'doc/cmd.rst')
| -rw-r--r-- | doc/cmd.rst | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/doc/cmd.rst b/doc/cmd.rst index c1f52ee7..b86650a0 100644 --- a/doc/cmd.rst +++ b/doc/cmd.rst @@ -1057,6 +1057,7 @@ a comma-separated list of these options, or in the :ref:`config_run_debug` section of the .coveragerc file. The debug output goes to stderr, unless the ``COVERAGE_DEBUG_FILE`` environment -variable names a different file, which will be appended to. +variable names a different file, which will be appended to. This can be useful +because many test runners capture output, which could hide important details. ``COVERAGE_DEBUG_FILE`` accepts the special names ``stdout`` and ``stderr`` to write to those destinations. |