diff options
| author | Ned Batchelder <ned@nedbatchelder.com> | 2019-04-13 10:48:22 -0400 |
|---|---|---|
| committer | Ned Batchelder <ned@nedbatchelder.com> | 2019-04-14 07:27:28 -0400 |
| commit | 17957da7467bda4a760e7c78ccf8fdc4adf61a39 (patch) | |
| tree | b871ebfc852aed266feb45d87cdf53e9cf987c84 /doc/config.rst | |
| parent | 5cca338ef0698a8c252df764ae94f72955f2543c (diff) | |
| download | python-coveragepy-git-17957da7467bda4a760e7c78ccf8fdc4adf61a39.tar.gz | |
Improve the docs for combine and [paths]
Diffstat (limited to 'doc/config.rst')
| -rw-r--r-- | doc/config.rst | 12 |
1 files changed, 8 insertions, 4 deletions
diff --git a/doc/config.rst b/doc/config.rst index 0b668351..dfff813a 100644 --- a/doc/config.rst +++ b/doc/config.rst @@ -198,16 +198,20 @@ equivalent when combining data from different machines:: /jenkins/build/*/src c:\myproj\src -The names of the entries are ignored, you may choose any name that you like. -The value is a list of strings. When combining data with the ``combine`` -command, two file paths will be combined if they start with paths from the same -list. +The names of the entries ("source" in this example) are ignored, you may choose +any name that you like. The value is a list of strings. When combining data +with the ``combine`` command, two file paths will be combined if they start +with paths from the same list. The first value must be an actual file path on the machine where the reporting will happen, so that source code can be found. The other values can be file patterns to match against the paths of collected data, or they can be absolute or relative file paths on the current machine. +In this example, data collected for "/jenkins/build/1234/src/module.py" will be +combined with data for "c:\myproj\src\module.py", and will be reported against +the source file found at "src/module.py". + See :ref:`cmd_combining` for more information. |