summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorOliver Bestwalter <oliver@bestwalter.de>2018-07-06 13:29:29 +0200
committerBernát Gábor <gaborjbernat@gmail.com>2018-07-06 12:29:29 +0100
commitb783630c88bcc3b84e97795b111ae7bfd7404caa (patch)
tree1c8bbdfb5791484e004463c0ab7fe8db3a8573e8
parent1641dc2f224575ba527eb34c8c0c34c13e83dec8 (diff)
downloadtox-git-b783630c88bcc3b84e97795b111ae7bfd7404caa.tar.gz
Formatting, clarify phrasing (#874)
* Formatting, clarify phrasing Pulling out this functionality in its own paragraph, spelling out the name of the character (dash) and adding an example makes this feature more visible. Might help with #870 * rst is not markdown * Fix formatting
-rw-r--r--doc/config.rst12
1 files changed, 10 insertions, 2 deletions
diff --git a/doc/config.rst b/doc/config.rst
index 8b1e6251..b42b493d 100644
--- a/doc/config.rst
+++ b/doc/config.rst
@@ -111,8 +111,16 @@ Complete list of settings that you can put into ``testenv*`` sections:
will be appended (and may contain another ``\`` character ...).
For eventually performing a call to ``subprocess.Popen(args, ...)``
``args`` are determined by splitting the whole command by whitespace.
- Similar to ``make`` recipe lines, any command with a leading ``-``
- will ignore the exit code.
+
+ To execute commands that can fail, they can be prefixed with a dash (``-``).
+ For these commands the exitcode is ignored. In this example ``ls -la`` will
+ always be executed although ``cat`` might return ``1`` for a not existing file::
+
+ commands =
+ - cat non-existing-file.txt
+ - ls -la
+
+ This is similar to ``make`` recipe lines.
.. confval:: install_command=ARGV