aboutsummaryrefslogtreecommitdiff
path: root/docs/markdown
diff options
context:
space:
mode:
authorJussi Pakkanen <jpakkane@gmail.com>2018-05-22 20:34:45 +0300
committerGitHub <noreply@github.com>2018-05-22 20:34:45 +0300
commitf4194d4dbc5c48ff9a0d76c779876aab60754230 (patch)
tree4f5a98896a6f808af617e53679bfa3b8dbf156f0 /docs/markdown
parent710a3f7f20ab2b37bdb5e554d9439e03276de444 (diff)
parent2e2d14c9d7f2d6747eeaced85aba781390d24133 (diff)
downloadmeson-f4194d4dbc5c48ff9a0d76c779876aab60754230.zip
meson-f4194d4dbc5c48ff9a0d76c779876aab60754230.tar.gz
meson-f4194d4dbc5c48ff9a0d76c779876aab60754230.tar.bz2
Merge pull request #3523 from taisei-project/run_command_check
Add 'check' kwarg for run_command
Diffstat (limited to 'docs/markdown')
-rw-r--r--docs/markdown/Reference-manual.md9
-rw-r--r--docs/markdown/snippets/run_command_check.md4
2 files changed, 12 insertions, 1 deletions
diff --git a/docs/markdown/Reference-manual.md b/docs/markdown/Reference-manual.md
index 2498b98..1e0e4c9 100644
--- a/docs/markdown/Reference-manual.md
+++ b/docs/markdown/Reference-manual.md
@@ -1016,7 +1016,7 @@ Project supports the following keyword arguments.
### run_command()
``` meson
- runresult run_command(command, list_of_args)
+ runresult run_command(command, list_of_args, ...)
```
Runs the command specified in positional arguments.
@@ -1031,6 +1031,13 @@ Meson will set three environment variables `MESON_SOURCE_ROOT`,
directory, build directory and subdirectory the target was defined in,
respectively.
+This function has one keyword argument.
+
+ - `check` takes a boolean. If `true`, the exit status code of the command will
+ be checked, and the configuration will fail if it is non-zero. The default is
+ `false`.
+ Since 0.47.0
+
See also [External commands](External-commands.md).
### run_target
diff --git a/docs/markdown/snippets/run_command_check.md b/docs/markdown/snippets/run_command_check.md
new file mode 100644
index 0000000..018456b
--- /dev/null
+++ b/docs/markdown/snippets/run_command_check.md
@@ -0,0 +1,4 @@
+## New 'check' keyword argument for the run_command function
+
+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.