aboutsummaryrefslogtreecommitdiff
path: root/docs/yaml
diff options
context:
space:
mode:
authorCharles Brunet <charles.brunet@optelgroup.com>2023-02-09 07:19:52 -0500
committerXavier Claessens <xclaesse@gmail.com>2023-02-14 10:50:10 -0500
commit04f233a80d570c90c1a152114cbf3bdad6a61607 (patch)
tree3910652b33a1867f8ec1cf26f1c5a495a9d8320f /docs/yaml
parent70286a93b00868d705647dcbfbd82ab0822040e8 (diff)
downloadmeson-04f233a80d570c90c1a152114cbf3bdad6a61607.zip
meson-04f233a80d570c90c1a152114cbf3bdad6a61607.tar.gz
meson-04f233a80d570c90c1a152114cbf3bdad6a61607.tar.bz2
allow install script to run in dry-run mode
Diffstat (limited to 'docs/yaml')
-rw-r--r--docs/yaml/builtins/meson.yaml12
1 files changed, 12 insertions, 0 deletions
diff --git a/docs/yaml/builtins/meson.yaml b/docs/yaml/builtins/meson.yaml
index 1dd746f..5ef445d 100644
--- a/docs/yaml/builtins/meson.yaml
+++ b/docs/yaml/builtins/meson.yaml
@@ -64,6 +64,9 @@ methods:
*(since 0.54.0)* If `meson install` is called with the `--quiet` option, the
environment variable `MESON_INSTALL_QUIET` will be set.
+ *(since 1.1.0)* If `meson install` is called with the `--dry-run` option, the
+ environment variable `MESON_INSTALL_DRY_RUN` will be set.
+
Meson uses the `DESTDIR` environment variable as set by the
inherited environment to determine the (temporary) installation
location for files. Your install script must be aware of this while
@@ -125,6 +128,15 @@ methods:
to install only a subset of the files.
By default the script has no install tag which means it is not being run when
`meson install --tags` argument is specified.
+
+ dry_run:
+ type: bool
+ since: 1.1.0
+ default: false
+ description: |
+ If `true` the script will be run even if `--dry-run` option is provided to
+ the `meson install` command. The script can use the `MESON_INSTALL_DRY_RUN`
+ variable to determine if it is in dry run mode or not.
- name: add_postconf_script
returns: void