aboutsummaryrefslogtreecommitdiff
path: root/docs/markdown/Reference-manual.md
diff options
context:
space:
mode:
authorMarc-André Lureau <marcandre.lureau@redhat.com>2019-09-25 13:23:16 +0400
committerXavier Claessens <xclaesse@gmail.com>2019-09-29 08:42:53 -0400
commita65d5801f363f70c01bc76c562d9b9e820dc52aa (patch)
tree8c50a9c7f66de012619e61a7dbdfaddd1bed0519 /docs/markdown/Reference-manual.md
parent18897b6afd35d7369658c9ecf562e2425256d6a9 (diff)
downloadmeson-a65d5801f363f70c01bc76c562d9b9e820dc52aa.zip
meson-a65d5801f363f70c01bc76c562d9b9e820dc52aa.tar.gz
meson-a65d5801f363f70c01bc76c562d9b9e820dc52aa.tar.bz2
environment: Support taking values from dict
Related to #5955.
Diffstat (limited to 'docs/markdown/Reference-manual.md')
-rw-r--r--docs/markdown/Reference-manual.md18
1 files changed, 14 insertions, 4 deletions
diff --git a/docs/markdown/Reference-manual.md b/docs/markdown/Reference-manual.md
index f296e43..6009d30 100644
--- a/docs/markdown/Reference-manual.md
+++ b/docs/markdown/Reference-manual.md
@@ -104,7 +104,10 @@ Add a custom test setup that can be used to run the tests with a
custom setup, for example under Valgrind. The keyword arguments are
the following:
-- `env` an [environment object](#environment-object) to use a custom environment
+- `env` environment variables to set, such as `['NAME1=value1',
+ 'NAME2=value2']`, or an [`environment()`
+ object](#environment-object) which allows more sophisticated
+ environment juggling. *Since 0.52.0* a dictionary is also accepted.
- `exe_wrapper` a list containing the wrapper command or script followed by the arguments to it
- `gdb` if `true`, the tests are also run under `gdb`
- `timeout_multiplier` a number to multiply the test timeout with
@@ -491,12 +494,16 @@ Print the argument string and halts the build process.
### environment()
``` meson
- environment_object environment()
+ environment_object environment(...)
```
Returns an empty [environment variable
object](#environment-object). Added in 0.35.0.
+Since *0.52.0* takes an optional dictionary as first argument. If
+provided, each key/value pair is added into the `environment_object`
+as if `set()` method was called for each of them.
+
### executable()
``` meson
@@ -1256,7 +1263,10 @@ This function supports the following keyword arguments:
be checked, and the configuration will fail if it is non-zero. The default is
`false`.
Since 0.47.0
- - `env` an [environment object](#environment-object) to use a custom environment
+ - `env` environment variables to set, such as `['NAME1=value1',
+ 'NAME2=value2']`, or an [`environment()`
+ object](#environment-object) which allows more sophisticated
+ environment juggling. *Since 0.52.0* a dictionary is also accepted.
Since 0.50.0
See also [External commands](External-commands.md).
@@ -1489,7 +1499,7 @@ Keyword arguments are the following:
- `env` environment variables to set, such as `['NAME1=value1',
'NAME2=value2']`, or an [`environment()`
object](#environment-object) which allows more sophisticated
- environment juggling
+ environment juggling. *Since 0.52.0* a dictionary is also accepted.
- `is_parallel` when false, specifies that no other test must be
running at the same time as this test