aboutsummaryrefslogtreecommitdiff
path: root/docs/markdown
diff options
context:
space:
mode:
authorAlistair Thomas <astavale@yahoo.co.uk>2018-03-22 17:11:26 +0000
committerJussi Pakkanen <jpakkane@gmail.com>2018-03-23 21:09:32 +0200
commit47f71d1a41bc11bfa5ab976462a1bf32d5f26c5f (patch)
tree50fa1292c8d333c923ad894b3d8de219dbcd0119 /docs/markdown
parente89008b657b2881523e91df2356900c98d2bdea2 (diff)
downloadmeson-47f71d1a41bc11bfa5ab976462a1bf32d5f26c5f.zip
meson-47f71d1a41bc11bfa5ab976462a1bf32d5f26c5f.tar.gz
meson-47f71d1a41bc11bfa5ab976462a1bf32d5f26c5f.tar.bz2
docs: Update test() to include that a program found with find_program() can be used [skip ci]
Diffstat (limited to 'docs/markdown')
-rw-r--r--docs/markdown/Reference-manual.md14
1 files changed, 11 insertions, 3 deletions
diff --git a/docs/markdown/Reference-manual.md b/docs/markdown/Reference-manual.md
index 128206b..26dd19a 100644
--- a/docs/markdown/Reference-manual.md
+++ b/docs/markdown/Reference-manual.md
@@ -1167,9 +1167,17 @@ argument to [`dependency()`](#dependency).
void test(name, executable, ...)
```
-Defines a unit test. Takes two positional arguments, the first is the
-name of this test and the second is the executable to run. Keyword
-arguments are the following.
+Defines a test to run with the test harness. Takes two positional arguments,
+the first is the name of the test and the second is the executable to run.
+The executable can be an [executable build target object](#build-target-object)
+returned by [`executable()`](#executable) or an
+[external program object](#external-program-object) returned by
+[`find_program()`](#find_program). The executable's exit code is used by the
+test harness to record the outcome of the test, for example exit code zero
+indicates success. For more on the Meson test harness protocol read
+[Unit Tests](Unit-tests.md).
+
+Keyword arguments are the following:
- `args` arguments to pass to the executable