diff options
| author | Xavier Claessens <xclaessens@netflix.com> | 2024-11-05 15:03:11 -0500 |
|---|---|---|
| committer | Jussi Pakkanen <jpakkane@gmail.com> | 2024-11-06 14:17:43 +0200 |
| commit | bfce1450ac68c1da7151b7ad1943f47bdd31f192 (patch) | |
| tree | 06b2250097b2ca488b3a942d6cd5fe88d02e25f7 /docs | |
| parent | 41dbfd93e455367993808a5975bc101231ccaa52 (diff) | |
| download | meson-bfce1450ac68c1da7151b7ad1943f47bdd31f192.zip meson-bfce1450ac68c1da7151b7ad1943f47bdd31f192.tar.gz meson-bfce1450ac68c1da7151b7ad1943f47bdd31f192.tar.bz2 | |
vcs_tag: Add install kwargs
Fixes: #4893
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/markdown/snippets/vcs_tag.md | 4 | ||||
| -rw-r--r-- | docs/yaml/functions/vcs_tag.yaml | 31 |
2 files changed, 35 insertions, 0 deletions
diff --git a/docs/markdown/snippets/vcs_tag.md b/docs/markdown/snippets/vcs_tag.md new file mode 100644 index 0000000..c60996a --- /dev/null +++ b/docs/markdown/snippets/vcs_tag.md @@ -0,0 +1,4 @@ +## Install vcs_tag() output + +[[vcs_tag]] now has `install`, `install_dir`, `install_tag` and `install_mode` +keyword arguments to install the generated file. diff --git a/docs/yaml/functions/vcs_tag.yaml b/docs/yaml/functions/vcs_tag.yaml index b4aad12..3a35684 100644 --- a/docs/yaml/functions/vcs_tag.yaml +++ b/docs/yaml/functions/vcs_tag.yaml @@ -55,3 +55,34 @@ kwargs: type: str default: "'@VCS_TAG@'" description: String in the input file to substitute with the commit information. + + install: + type: bool + default: false + since: 1.7.0 + description: | + When true, this generated file is installed during + the install step, and `install_dir` must be set and not empty. + + install_dir: + type: str + since: 1.7.0 + description: | + The subdirectory to install the generated file to (e.g. `share/myproject`). + + install_mode: + type: list[str | int] + since: 1.7.0 + description: | + Specify the file mode in symbolic format + and optionally the owner/uid and group/gid for the installed files. + + See the `install_mode` kwarg of [[install_data]] for more information. + + install_tag: + type: str + since: 1.7.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. |