summaryrefslogtreecommitdiff
path: root/doc/cmd.rst
diff options
context:
space:
mode:
authorNed Batchelder <ned@nedbatchelder.com>2019-11-17 07:52:24 -0500
committerNed Batchelder <ned@nedbatchelder.com>2019-12-01 08:35:04 -0500
commit013e9de08c0747fddf92cc1fdac1d1f39185aa3b (patch)
treeada87dee565d5b167e424df6d9143ec49de349fa /doc/cmd.rst
parent10e41ab0dc165b3fd010345ab0fb1ed319d2f230 (diff)
downloadpython-coveragepy-git-013e9de08c0747fddf92cc1fdac1d1f39185aa3b.tar.gz
Experimental: relative_files to support relative file names.
Diffstat (limited to 'doc/cmd.rst')
-rw-r--r--doc/cmd.rst7
1 files changed, 5 insertions, 2 deletions
diff --git a/doc/cmd.rst b/doc/cmd.rst
index b945bf2c..4038fd82 100644
--- a/doc/cmd.rst
+++ b/doc/cmd.rst
@@ -270,8 +270,11 @@ different subdirectory. Coverage needs to know that different file paths are
actually the same source file for reporting purposes.
You can tell coverage.py how different source locations relate with a
-``[paths]`` section in your configuration file. See :ref:`config_paths` for
-details.
+``[paths]`` section in your configuration file (see :ref:`config_paths`).
+It might be more convenient to use the ``[run] relative_files``
+setting to store relative file paths (see :ref:`relative_files
+<config_run_relative_files>`).
+
If any of the data files can't be read, coverage.py will print a warning
indicating the file and the problem.