summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNed Batchelder <ned@nedbatchelder.com>2010-09-19 16:39:42 -0400
committerNed Batchelder <ned@nedbatchelder.com>2010-09-19 16:39:42 -0400
commitd9aabadb85ce093f3fdd2a4e8bf5bae327eb6405 (patch)
tree0a2237d5cd37880d2208aaa10668b480148e9bc9
parent43a2b30a875e14bdead28bbd819548d09e2bce8c (diff)
downloadpython-coveragepy-git-d9aabadb85ce093f3fdd2a4e8bf5bae327eb6405.tar.gz
Clarify where the configuration file goes.
-rw-r--r--doc/config.rst5
1 files changed, 5 insertions, 0 deletions
diff --git a/doc/config.rst b/doc/config.rst
index bcb24412..3fe772fe 100644
--- a/doc/config.rst
+++ b/doc/config.rst
@@ -17,6 +17,11 @@ specification of options that are otherwise only available in the
Configuration files also make it easier to get coverage testing of spawned
sub-processes. See :ref:`subprocess` for more details.
+The default name for configuration files is ``.coveragerc``, in the same
+directory coverage.py is being run in. Most of the settings in the
+configuration file are tied to your source code and how it should be
+measured, so it should be stored with your source, and checked into
+source control, rather than put in your home directory.
Syntax