summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNed Batchelder <ned@nedbatchelder.com>2012-08-07 21:29:07 -0400
committerNed Batchelder <ned@nedbatchelder.com>2012-08-07 21:29:07 -0400
commit8ecba376fabb6300e6ce2b71fa07737fde7cf7ab (patch)
treea7c71e23df4d5604d4cfd72cc70606e4dc033a6d
parent452bceaef085a0c90464ee009b737e6c8c18220e (diff)
downloadpython-coveragepy-git-8ecba376fabb6300e6ce2b71fa07737fde7cf7ab.tar.gz
Clarify the rules for naming data files so they can be combined.
-rw-r--r--doc/cmd.rst11
1 files changed, 11 insertions, 0 deletions
diff --git a/doc/cmd.rst b/doc/cmd.rst
index 5b4eb2dc..4cc2e229 100644
--- a/doc/cmd.rst
+++ b/doc/cmd.rst
@@ -14,6 +14,7 @@ Coverage command line usage
:history: 20110827T212500, updated for 3.5.1, combining aliases
:history: 20120119T075600, Added some clarification from George Paci
:history: 20120504T091800, Added info about execution warnings, and 3.5.2 stuff.
+:history: 20120807T211600, Clarified the combine rules.
.. highlight:: console
@@ -171,6 +172,16 @@ systems, coverage won't know how to combine the data. You can tell coverage
how the different locations correlate with a ``[paths]`` section in your
configuration file. See :ref:`config_paths` for details.
+If you are collecting and renaming your own data files, you'll need to name
+properly for **combine** to find them. It looks for files named after the
+data file (defaulting to ".coverage", overridable with COVERAGE_FILE), with a
+dotted suffix. All such files in the current directory will be combined. Here
+are some examples of combinable data files::
+
+ .coverage.machine1
+ .coverage.20120807T212300
+ .coverage.last_good_run.ok
+
.. _cmd_reporting: