aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJussi Pakkanen <jpakkane@gmail.com>2018-02-04 19:06:02 +0200
committerJussi Pakkanen <jpakkane@gmail.com>2018-02-04 19:06:02 +0200
commit4637cf4e95160a90818e50299ad2ba1a7a9b0614 (patch)
tree9d2d5c7718bb15b6ad55ec6c53a24fec0b5cb137
parent6f510ca695f282c979f62671df6de3de020821f3 (diff)
downloadmeson-4637cf4e95160a90818e50299ad2ba1a7a9b0614.zip
meson-4637cf4e95160a90818e50299ad2ba1a7a9b0614.tar.gz
meson-4637cf4e95160a90818e50299ad2ba1a7a9b0614.tar.bz2
Fix run target documentation. Closes #1793.
-rw-r--r--docs/markdown/Reference-manual.md7
1 files changed, 5 insertions, 2 deletions
diff --git a/docs/markdown/Reference-manual.md b/docs/markdown/Reference-manual.md
index 31c4953..390371b 100644
--- a/docs/markdown/Reference-manual.md
+++ b/docs/markdown/Reference-manual.md
@@ -945,13 +945,16 @@ respectively.
### run_target
``` meson
- buildtarget run_target(target_name, ...)
+runtarget run_target(target_name, ...)
```
This function creates a new top-level target that runs a specified
command with the specified arguments. Like all top-level targets, this
integrates with the selected backend. For instance, with Ninja you can
-run it as `ninja target_name`.
+run it as `ninja target_name`. Note that a run target produces no
+output as far as Meson is concerned. It is only meant for tasks such
+as running a code formatter or flashing an external device's firmware
+with a built file.
The script is run from an *unspecified* directory, and Meson will set
three environment variables `MESON_SOURCE_ROOT`, `MESON_BUILD_ROOT`