summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorNed Batchelder <ned@nedbatchelder.com>2012-11-25 17:16:59 -0500
committerNed Batchelder <ned@nedbatchelder.com>2012-11-25 17:16:59 -0500
commit8416ddba416b9a4c12fb1033101bbca9d11ac8ca (patch)
treee2fab0b701bc7d9c8de4f7d3e4a65a9079508492 /doc
parentc33865dc58bf1e0c2aaa9a935d1c8594b844dee3 (diff)
downloadpython-coveragepy-git-8416ddba416b9a4c12fb1033101bbca9d11ac8ca.tar.gz
Config files now can use environment variables. #97.
Diffstat (limited to 'doc')
-rw-r--r--doc/config.rst5
1 files changed, 5 insertions, 0 deletions
diff --git a/doc/config.rst b/doc/config.rst
index 159a42f5..f6d8f1fc 100644
--- a/doc/config.rst
+++ b/doc/config.rst
@@ -39,6 +39,11 @@ values on multiple lines.
Boolean values can be specified as ``on``, ``off``, ``true``, ``false``, ``1``,
or ``0`` and are case-insensitive.
+Environment variables can be substituted in by using dollar signs: ``$WORD``
+``${WORD}`` will be replaced with the value of ``WORD`` in the environment.
+A dollar sign can be inserted with ``$$``. Missing environment variables
+will result in empty strings with no error.
+
Many sections and values correspond roughly to commands and options in
the :ref:`command-line interface <cmd>`.