From 4e1e98cc315ec46a94b6bca2b37ae2900f20f816 Mon Sep 17 00:00:00 2001 From: Daniel Mensinger Date: Sun, 22 Aug 2021 20:37:51 +0200 Subject: docs: added install_tag docs --- docs/yaml/builtins/meson.yaml | 9 ++++++ docs/yaml/functions/_build_target_base.yaml | 8 +++++ docs/yaml/functions/configure_file.yaml | 8 +++++ docs/yaml/functions/custom_target.yaml | 48 ++++++++++++++++++----------- docs/yaml/functions/install_data.yaml | 8 +++++ docs/yaml/functions/install_subdir.yaml | 8 +++++ 6 files changed, 71 insertions(+), 18 deletions(-) diff --git a/docs/yaml/builtins/meson.yaml b/docs/yaml/builtins/meson.yaml index b217055..30afafd 100644 --- a/docs/yaml/builtins/meson.yaml +++ b/docs/yaml/builtins/meson.yaml @@ -102,6 +102,15 @@ methods: This is useful in the case the script updates system wide cache that is only needed when copying files into final destination. + install_tag: + type: str + since: 0.60.0 + description: | + A string used by the `meson install --tags` command + 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. + - name: add_postconf_script returns: void description: | diff --git a/docs/yaml/functions/_build_target_base.yaml b/docs/yaml/functions/_build_target_base.yaml index 53808d8..62424b6 100644 --- a/docs/yaml/functions/_build_target_base.yaml +++ b/docs/yaml/functions/_build_target_base.yaml @@ -175,6 +175,14 @@ kwargs: See the `install_mode` kwarg of [[install_data]] for more information. + install_tag: + type: str + since: 0.60.0 + description: | + A string used by the `meson install --tags` command + to install only a subset of the files. By default all build targets have the + tag `runtime` except for static libraries that have the `devel` tag. + install_rpath: type: str description: | diff --git a/docs/yaml/functions/configure_file.yaml b/docs/yaml/functions/configure_file.yaml index bd94779..4bce368 100644 --- a/docs/yaml/functions/configure_file.yaml +++ b/docs/yaml/functions/configure_file.yaml @@ -101,6 +101,14 @@ kwargs: See the `install_mode` kwarg of [[install_data]] for more information. + install_tag: + type: str + since: 0.60.0 + description: | + A string used by the `meson install --tags` command + to install only a subset of the files. By default the file has no install + tag which means it is not being installed when `--tags` argument is specified. + output: type: str description: | diff --git a/docs/yaml/functions/custom_target.yaml b/docs/yaml/functions/custom_target.yaml index cf8312e..93e901a 100644 --- a/docs/yaml/functions/custom_target.yaml +++ b/docs/yaml/functions/custom_target.yaml @@ -151,24 +151,24 @@ kwargs: description: | If only one install_dir is provided, all outputs are installed there. *Since 0.40.0* Allows you to specify the installation directory for each - corresponding output. For example: - ``` - custom_target('different-install-dirs', - output : ['first.file', 'second.file'], - install : true, - install_dir : ['somedir', 'otherdir]) - ``` - This would install `first.file` to `somedir` and `second.file` to `otherdir`. - - To only install some outputs, pass `false` for the outputs that you - don't want installed. For example: - ``` - custom_target('only-install-second', - output : ['first.file', 'second.file'], - install : true, - install_dir : [false, 'otherdir]) - ``` - This would install `second.file` to `otherdir` and not install `first.file`. + corresponding output. For example: + ```meson + custom_target('different-install-dirs', + output : ['first.file', 'second.file'], + install : true, + install_dir : ['somedir', 'otherdir]) + ``` + This would install `first.file` to `somedir` and `second.file` to `otherdir`. + + To only install some outputs, pass `false` for the outputs that you + don't want installed. For example: + ```meson + custom_target('only-install-second', + output : ['first.file', 'second.file'], + install : true, + install_dir : [false, 'otherdir]) + ``` + This would install `second.file` to `otherdir` and not install `first.file`. install_mode: type: list[str | int] @@ -177,6 +177,18 @@ kwargs: The file mode and optionally the owner/uid and group/gid. See the `install_mode` kwarg of [[install_data]] for more information. + install_tag: + type: list[str] + since: 0.60.0 + description: | + A list of strings, one per output, used by the `meson install --tags` command + to install only a subset of the files. + + By default all outputs have no install tag which means they are not being + installed when `--tags` argument is specified. If only one tag is specified, + it is assumed that all outputs have the same tag. `false` can be used for + outputs that have no tag or are not installed. + output: type: list[str] description: List of output files. diff --git a/docs/yaml/functions/install_data.yaml b/docs/yaml/functions/install_data.yaml index be5dcfe..3bb9802 100644 --- a/docs/yaml/functions/install_data.yaml +++ b/docs/yaml/functions/install_data.yaml @@ -35,6 +35,14 @@ kwargs: To leave any of these three as the default, specify `false`. + install_tag: + type: str + since: 0.60.0 + description: | + A string used by the `meson install --tags` command + to install only a subset of the files. By default these files have no install + tag which means they are not being installed when `--tags` argument is specified. + rename: type: list[str] since: 0.46.0 diff --git a/docs/yaml/functions/install_subdir.yaml b/docs/yaml/functions/install_subdir.yaml index a57bd27..83df782 100644 --- a/docs/yaml/functions/install_subdir.yaml +++ b/docs/yaml/functions/install_subdir.yaml @@ -68,6 +68,14 @@ kwargs: See the `install_mode` kwarg of [[install_data]] for more information. + install_tag: + type: str + since: 0.60.0 + description: | + A string used by the `meson install --tags` command + to install only a subset of the files. By default these files have no install + tag which means they are not being installed when `--tags` argument is specified. + exclude_files: type: list[str] description: | -- cgit v1.1