aboutsummaryrefslogtreecommitdiff
path: root/docs/markdown
diff options
context:
space:
mode:
authorNirbheek Chauhan <nirbheek.chauhan@gmail.com>2018-03-06 15:33:00 +0530
committerGitHub <noreply@github.com>2018-03-06 15:33:00 +0530
commit9e18e4c703ef85450ac6a16ae3cc9d785d3e1691 (patch)
tree6fbdf5c70f7e513c3d9cc52718027273a7017a4b /docs/markdown
parent7842bc03dd581c4beaa1b94746b5dfe5d38986c6 (diff)
downloadmeson-9e18e4c703ef85450ac6a16ae3cc9d785d3e1691.zip
meson-9e18e4c703ef85450ac6a16ae3cc9d785d3e1691.tar.gz
meson-9e18e4c703ef85450ac6a16ae3cc9d785d3e1691.tar.bz2
Improve vcs_tag documentation [skip ci]
Document that dependencies must be explicitly signalled, just like with a custom target.
Diffstat (limited to 'docs/markdown')
-rw-r--r--docs/markdown/Reference-manual.md16
1 files changed, 12 insertions, 4 deletions
diff --git a/docs/markdown/Reference-manual.md b/docs/markdown/Reference-manual.md
index a02ad1c..e816795 100644
--- a/docs/markdown/Reference-manual.md
+++ b/docs/markdown/Reference-manual.md
@@ -1197,10 +1197,18 @@ be up to date on every build. Keywords are similar to `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`.
+result to `output`. This method returns a
+[`custom_target`](#custom_target) object that (as usual) should be
+used to signal dependencies if other targets use the file outputted
+by this.
+
+For example, if you generate a header with this and want to use that in
+a build target, you must add the return value to the sources of that
+build target. Without that, Meson will not know the order in which to
+build the targets.
+
+If you desire more specific behavior than what this command provides,
+you should use `custom_target`.
## Built-in objects