diff options
| author | Jussi Pakkanen <jpakkane@gmail.com> | 2017-05-05 17:17:49 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-05-05 17:17:49 +0200 |
| commit | bae7861c1c4ac2616c6f3b7b615aba782547e05c (patch) | |
| tree | 130f2026257c238ff64b4e8e2ea737f3cca37638 /docs/markdown | |
| parent | c96557c9ed790ebe3c6205d143b7f8c75875236f (diff) | |
| parent | 7a3be163cbceb9f569ff454dc23fdfecadc166cc (diff) | |
| download | meson-bae7861c1c4ac2616c6f3b7b615aba782547e05c.zip meson-bae7861c1c4ac2616c6f3b7b615aba782547e05c.tar.gz meson-bae7861c1c4ac2616c6f3b7b615aba782547e05c.tar.bz2 | |
Merge pull request #1722 from whot/doc-fixes
fixes for vcs_tag
Diffstat (limited to 'docs/markdown')
| -rw-r--r-- | docs/markdown/Reference-manual.md | 12 | ||||
| -rw-r--r-- | docs/markdown/Release-notes-for-0.41.0.md | 5 |
2 files changed, 12 insertions, 5 deletions
diff --git a/docs/markdown/Reference-manual.md b/docs/markdown/Reference-manual.md index 116fd58..9c4df7e 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 (defaults to `meson.project_version()`) +- `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 you should put in your main program. 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 diff --git a/docs/markdown/Release-notes-for-0.41.0.md b/docs/markdown/Release-notes-for-0.41.0.md index 6e00ecd..9c02cdc 100644 --- a/docs/markdown/Release-notes-for-0.41.0.md +++ b/docs/markdown/Release-notes-for-0.41.0.md @@ -12,3 +12,8 @@ Add features here as code is merged to master. ## Dependency Handler for LLVM Native support for linking against LLVM using the `dependency` function. + +## vcs_tag keyword fallback is is now optional + +The `fallback` keyword in `vcs_tag` is now optional. If not given, its value +defaults to the return value of `meson.project_version()`. |