summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorNed Batchelder <ned@nedbatchelder.com>2022-09-16 17:48:02 -0400
committerNed Batchelder <ned@nedbatchelder.com>2022-09-16 18:17:55 -0400
commit7b690aa976a6bb30261d68344104f817a812a677 (patch)
treee81568929e612ee14674d7a71abf3370c6d346b1 /doc
parent30d37e59e50b75c057a09fddf5b92869c0858949 (diff)
downloadpython-coveragepy-git-7b690aa976a6bb30261d68344104f817a812a677.tar.gz
feat: --debug=pathmap will show details of re-mapping due to [paths] setting.
Diffstat (limited to 'doc')
-rw-r--r--doc/cmd.rst3
-rw-r--r--doc/config.rst3
2 files changed, 6 insertions, 0 deletions
diff --git a/doc/cmd.rst b/doc/cmd.rst
index e2a60fc2..c05b7bce 100644
--- a/doc/cmd.rst
+++ b/doc/cmd.rst
@@ -1000,6 +1000,9 @@ of operation to log:
* ``multiproc``: log the start and stop of multiprocessing processes.
+* ``pathmap``: log the remapping of paths that happens during ``coverage
+ combine`` due to the ``[paths]`` setting. See :ref:`config_paths`.
+
* ``pid``: annotate all warnings and debug output with the process and thread
ids.
diff --git a/doc/config.rst b/doc/config.rst
index 1b6f128d..66b02eac 100644
--- a/doc/config.rst
+++ b/doc/config.rst
@@ -350,6 +350,9 @@ against the source file found at "src/module.py".
If you specify more than one list of paths, they will be considered in order.
The first list that has a match will be used.
+The ``--debug=pathmap`` option can be used to log details of the re-mapping of
+paths. See :ref:`the --debug option <cmd_run_debug>`.
+
See :ref:`cmd_combine` for more information.