summaryrefslogtreecommitdiff
path: root/docs/markdown/snippets/run_command_check.md
diff options
context:
space:
mode:
authorNirbheek Chauhan <nirbheek@centricular.com>2018-04-15 14:44:41 +0530
committerNirbheek Chauhan <nirbheek@centricular.com>2018-06-10 07:44:49 +0530
commit6df3cb7ab0e686ae976c67a24ce9664ffe5e1d86 (patch)
treebabfe469706c95e56783313fe97e4516b1e814d0 /docs/markdown/snippets/run_command_check.md
parent2d1fc25599adf349ae62504ce2197e2d821398f7 (diff)
downloadmeson-nirbheek/run_command_capture.tar.gz
run_command: Add new kwarg 'capture'nirbheek/run_command_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/run_command_check.md')
-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 018456b19..35bdcdd7e 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`.