diff options
| author | Ned Batchelder <ned@nedbatchelder.com> | 2023-01-22 09:08:09 -0500 |
|---|---|---|
| committer | Ned Batchelder <ned@nedbatchelder.com> | 2023-01-22 10:58:53 -0500 |
| commit | 5f65d87b14245d4523bc866a75a16b6c55a7ce70 (patch) | |
| tree | bd4d404c80baa1c7e6e25e2335ffcee52702ee66 /doc | |
| parent | c51ac463f07e31c87b20f50bd7e6445e4e4e83a2 (diff) | |
| download | python-coveragepy-git-5f65d87b14245d4523bc866a75a16b6c55a7ce70.tar.gz | |
feat: the debug output file can be specified in the config file. #1319
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/cmd.rst | 11 | ||||
| -rw-r--r-- | doc/config.rst | 9 |
2 files changed, 15 insertions, 5 deletions
diff --git a/doc/cmd.rst b/doc/cmd.rst index b86650a0..0704e940 100644 --- a/doc/cmd.rst +++ b/doc/cmd.rst @@ -1056,8 +1056,9 @@ Debug options can also be set with the ``COVERAGE_DEBUG`` environment variable, 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. 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. +The debug output goes to stderr, unless the :ref:`config_run_debug_file` +setting or the ``COVERAGE_DEBUG_FILE`` environment 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. diff --git a/doc/config.rst b/doc/config.rst index 90949506..8e3d885b 100644 --- a/doc/config.rst +++ b/doc/config.rst @@ -203,6 +203,15 @@ include a short string at the end, the name of the warning. See <cmd_run_debug>` for details. +.. _config_run_debug_file: + +[run] debug_file +................ + +(string) A file name to write debug output to. See :ref:`the run --debug +option <cmd_run_debug>` for details. + + .. _config_run_dynamic_context: [run] dynamic_context |