summaryrefslogtreecommitdiff
path: root/doc/config.rst
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
commit86eb1db2365143d025fa64a67587c1723977e787 (patch)
treec05a2692889c132ce9a7eaea0fec2d3f29873fe3 /doc/config.rst
parent34fdddd0dae03ab57289dfe5807158e672f7f9ef (diff)
downloadpython-coveragepy-86eb1db2365143d025fa64a67587c1723977e787.tar.gz
Config files now can use environment variables. #97.
Diffstat (limited to 'doc/config.rst')
-rw-r--r--doc/config.rst5
1 files changed, 5 insertions, 0 deletions
diff --git a/doc/config.rst b/doc/config.rst
index 159a42f..f6d8f1f 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>`.