aboutsummaryrefslogtreecommitdiff
path: root/docs/markdown/snippets
diff options
context:
space:
mode:
authorNirbheek Chauhan <nirbheek@centricular.com>2018-04-15 14:44:41 +0530
committerNirbheek Chauhan <nirbheek.chauhan@gmail.com>2018-06-18 10:51:46 +0000
commitc9a89027accff8385028a2b5e93465d28c63be36 (patch)
tree2dbfe29f7e1363de6054f20d377418492ca0b1f8 /docs/markdown/snippets
parentcbe18e01e49613f0db30c563c80767b30325bf39 (diff)
downloadmeson-c9a89027accff8385028a2b5e93465d28c63be36.zip
meson-c9a89027accff8385028a2b5e93465d28c63be36.tar.gz
meson-c9a89027accff8385028a2b5e93465d28c63be36.tar.bz2
run_command: Add new kwarg 'capture'
capture: false means we won't try to read the stdout at all. Closes https://github.com/mesonbuild/meson/issues/3364
Diffstat (limited to 'docs/markdown/snippets')
-rw-r--r--docs/markdown/snippets/run_command_check.md9
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`.