diff options
Diffstat (limited to 'docs/markdown')
| -rw-r--r-- | docs/markdown/snippets/run_command_check.md | 9 |
1 files changed, 7 insertions, 2 deletions
diff --git a/docs/markdown/snippets/run_command_check.md b/docs/markdown/snippets/run_command_check.md index 018456b..35bdcdd 100644 --- a/docs/markdown/snippets/run_command_check.md +++ b/docs/markdown/snippets/run_command_check.md @@ -1,4 +1,9 @@ -## New 'check' keyword argument for the run_command function +## New keyword arguments: 'check' and 'capture' for run_command() -If `check` is `true`, then the configuration will fail if the command returns a +If `check:` is `true`, then the configuration will fail if the command returns a non-zero exit status. The default value is `false` for compatibility reasons. + +`run_command()` used to always capture the output and stored it for use in +build files. However, sometimes the stdout is in a binary format which is meant +to be discarded. For that case, you can now set the `capture:` keyword argument +to `false`. |