diff options
| author | Peter Hutterer <peter.hutterer@who-t.net> | 2017-05-03 11:25:44 +1000 |
|---|---|---|
| committer | Peter Hutterer <peter.hutterer@who-t.net> | 2017-05-05 08:11:04 +1000 |
| commit | 4378655a39be1d693a73432f344b74600c4d8651 (patch) | |
| tree | 3bf253ab850ce4a3023fa775d6f11554d8c109e4 /docs/markdown | |
| parent | e982d5118e9056e2e08810fa6ca24cf7c24495b9 (diff) | |
| download | meson-4378655a39be1d693a73432f344b74600c4d8651.zip meson-4378655a39be1d693a73432f344b74600c4d8651.tar.gz meson-4378655a39be1d693a73432f344b74600c4d8651.tar.bz2 | |
docs: document additional args for vcs_tag
Supported as of 223596d7bf8ab9b839e0031022c132a3ccd4fd1d
Diffstat (limited to 'docs/markdown')
| -rw-r--r-- | docs/markdown/Reference-manual.md | 12 |
1 files changed, 7 insertions, 5 deletions
diff --git a/docs/markdown/Reference-manual.md b/docs/markdown/Reference-manual.md index cbcbbdc..66027c2 100644 --- a/docs/markdown/Reference-manual.md +++ b/docs/markdown/Reference-manual.md @@ -635,13 +635,15 @@ Defined tests can be run in a backend-agnostic way by calling `mesontest` inside ctarget vcs_tag(...) ``` -This command detects revision control commit information at build time and places it in the specified output file. This file is guaranteed to be up to date on every build. Keywords are similar to `custom_target` and all of them are mandatory. +This command detects revision control commit information at build time and places it in the specified output file. This file is guaranteed to be up to date on every build. Keywords are similar to `custom_target`. -- `input` file to modify (e.g. `version.c.in`) -- `output` file to write the results to (e.g. `version.c`) -- `fallback` version number to use when no revision control information is present, such as when building from a release tarball +- `input` file to modify (e.g. `version.c.in`) (required) +- `output` file to write the results to (e.g. `version.c`) (required) +- `fallback` version number to use when no revision control information is present, such as when building from a release tarball (required) +- `command` string list with the command to execute, see [`custom_target`](#custom_target) for details on how this command must be specified +- `replace_string` string in the input file to substitute with the commit information (defaults to `@VCS_TAG@`) -Meson will read the contents of `input`, replace the string `@VCS_TAG@` with the detected revision number and write the result to `output`. This method returns an opaque [`custom_target`](#custom_target) object that can be used as source. If you desire more specific behavior than what this command provides, you should use `custom_target`. +Meson will read the contents of `input`, substitute the `replace_string` with the detected revision number, and write the result to `output`. This method returns an opaque [`custom_target`](#custom_target) object that can be used as source. If you desire more specific behavior than what this command provides, you should use `custom_target`. ## Built-in objects |