aboutsummaryrefslogtreecommitdiff
path: root/docs/markdown/Contributing.md
diff options
context:
space:
mode:
authorJon Turney <jon.turney@dronecode.org.uk>2021-06-24 13:27:44 +0100
committerDaniel Mensinger <daniel@mensinger-ka.de>2021-07-07 20:08:12 +0200
commitc78e6cac80ecb55b51d30346accc232e28555d56 (patch)
treecbdfbccc0000b5ed80f786ecfc61c86f2ffc02fe /docs/markdown/Contributing.md
parenta2e44296c9cf36ff1269ccfb427b90b5a848ee7d (diff)
downloadmeson-c78e6cac80ecb55b51d30346accc232e28555d56.zip
meson-c78e6cac80ecb55b51d30346accc232e28555d56.tar.gz
meson-c78e6cac80ecb55b51d30346accc232e28555d56.tar.bz2
Allow `skip_*` test.json keys at top-level or in `matrix:`
Diffstat (limited to 'docs/markdown/Contributing.md')
-rw-r--r--docs/markdown/Contributing.md16
1 files changed, 10 insertions, 6 deletions
diff --git a/docs/markdown/Contributing.md b/docs/markdown/Contributing.md
index 474f880..03fc2a4 100644
--- a/docs/markdown/Contributing.md
+++ b/docs/markdown/Contributing.md
@@ -305,17 +305,15 @@ project tests with different Meson options.
In the `options` dict, all possible options and their values are
specified. Each key in the `options` dict is a Meson option. It stores
-a list of all potential values in a dict format, which allows to skip
-specific values based on the current environment.
+a list of all potential values in a dict format.
Each value must contain the `val` key for the value of the option.
`null` can be used for adding matrix entries without the current
option.
-Additionally, the `skip_on_env` key can be used to specify a list of
-environment variables. If at least one environment variable in
-`skip_on_env` is present, all matrix entries containing this value are
-skipped.
+The `skip_on_env`, `skip_on_jobname` and `skip_on_os` keys (as described below)
+may be used in the value to skip that matrix entry, based on the current
+environment.
Similarly, the `compilers` key can be used to define a mapping of
compilers to languages that are required for this value.
@@ -380,6 +378,12 @@ matched:
| `literal` | Literal match (default) |
| `re` | regex match |
+#### skip_on_env
+
+The `skip_on_env` key can be used to specify a list of environment variables. If
+at least one environment variable in the `skip_on_env` list is present, the test
+is skipped.
+
#### skip_on_jobname
The `skip_on_jobname` key contains a list of strings. If the `MESON_CI_JOBNAME`