summaryrefslogtreecommitdiff
path: root/doc/config.txt
diff options
context:
space:
mode:
Diffstat (limited to 'doc/config.txt')
-rw-r--r--doc/config.txt20
1 files changed, 20 insertions, 0 deletions
diff --git a/doc/config.txt b/doc/config.txt
index d2d2854..22b4de1 100644
--- a/doc/config.txt
+++ b/doc/config.txt
@@ -110,6 +110,26 @@ Complete list of settings that you can put into ``testenv*`` sections:
pip install {opts} {packages}
+.. confval:: ignore_errors=True|False(default)
+
+ .. versionadded:: 2.0
+
+ If ``True``, a non-zero exit code from one command will be ignored and
+ further commands will be executed (which was the default behavior in tox <
+ 2.0). If ``False`` (the default), then a non-zero exit code from one command
+ will abort execution of commands for that environment.
+
+ It may be helpful to note that this setting is analogous to the ``-i`` or
+ ``ignore-errors`` option of GNU Make. A similar name was chosen to reflect the
+ similarity in function.
+
+ Note that in tox 2.0, the default behavior of tox with respect to
+ treating errors from commands changed. Tox < 2.0 would ignore errors by
+ default. Tox >= 2.0 will abort on an error by default, which is safer and more
+ typical of CI and command execution tools, as it doesn't make sense to
+ run tests if installing some prerequisite failed and it doesn't make sense to
+ try to deploy if tests failed.
+
.. confval:: pip_pre=True|False(default)
.. versionadded:: 1.9