summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEugene Yunak <eugene@yunak.eu>2014-06-18 13:03:34 +0300
committerEugene Yunak <eugene@yunak.eu>2014-06-18 13:03:34 +0300
commit82bc07071e538b45156ce2baecf747f639559740 (patch)
tree92112c97d718b5635087f388b7ca727a9782b544
parente9011ab3375632098a7d8877927b746b407c41e7 (diff)
downloadtox-82bc07071e538b45156ce2baecf747f639559740.tar.gz
skip_missing_interpreters: move documentation into a separate confval section
-rw-r--r--doc/config.txt19
1 files changed, 12 insertions, 7 deletions
diff --git a/doc/config.txt b/doc/config.txt
index fd7f79f..23bf128 100644
--- a/doc/config.txt
+++ b/doc/config.txt
@@ -22,7 +22,6 @@ List of optional global options::
distshare=path # defaults to {homedir}/.tox/distshare
envlist=ENVLIST # defaults to the list of all environments
skipsdist=BOOL # defaults to false
- skip_missing_interpreters=BOOL # defaults to false
``tox`` autodetects if it is running in a Jenkins_ context
@@ -33,12 +32,18 @@ and will first lookup global tox settings in this section::
... # override [tox] settings for the jenkins context
# note: for jenkins distshare defaults to ``{toxworkdir}/distshare``.
-Setting ``skip_missing_interpreters`` to ``True`` is equivalent of passing the
-``--skip-missing-interpreters`` command line option, and will force ``tox`` to
-return success even if some of the specified environments were missing. This is
-useful for some CI systems or running on a developer box, where you might only
-have a subset of all your supported interpreters installed but don't want to
-mark the build as failed because of it.
+.. confval:: skip_missing_interpreters=BOOL
+
+ .. versionadded:: 1.7.2
+
+ Setting this to ``True`` is equivalent of passing the
+ ``--skip-missing-interpreters`` command line option, and will force ``tox`` to
+ return success even if some of the specified environments were missing. This is
+ useful for some CI systems or running on a developer box, where you might only
+ have a subset of all your supported interpreters installed but don't want to
+ mark the build as failed because of it. As expected, the command line switch
+ always overrides this setting if passed on the invokation.
+ **Default:** ``False``
envlist setting
+++++++++++++++