summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMarc Herbert <marc.herbert@gmail.com>2020-01-28 10:52:26 -0800
committerNirbheek Chauhan <nirbheek.chauhan@gmail.com>2020-02-06 11:33:00 +0530
commit9e365e4d0a461785860266812d42f47000a31bae (patch)
tree0c725bfb8668ce9f9b4306617fb4f20f2598fa20
parent8978717b6b51652bd455efbb6867f3f5799726c9 (diff)
downloadmeson-9e365e4d0a461785860266812d42f47000a31bae.tar.gz
docs: explain the purpose of order-only deps for generated files [skip ci]
The documentation of "order-only" dependencies is limited and their various purposes are especially not clear. See issue #6391 for a recent example, search the internet for many more. So mention the particular purpose here while making the documentation barely longer.
-rw-r--r--docs/markdown/Reference-manual.md11
1 files changed, 6 insertions, 5 deletions
diff --git a/docs/markdown/Reference-manual.md b/docs/markdown/Reference-manual.md
index f4fa89eb8..ae6d1c5a8 100644
--- a/docs/markdown/Reference-manual.md
+++ b/docs/markdown/Reference-manual.md
@@ -547,11 +547,12 @@ libraries (`.so`, `.dll`, etc) will be linked.
With the Ninja backend, Meson will create a build-time [order-only
dependency](https://ninja-build.org/manual.html#ref_dependencies) on
-all generated input files, including unknown files. For all input
-files (generated and non-generated), Meson uses the [dependency
-file](https://ninja-build.org/manual.html#ref_headers) generated by
-your compiler to determine when to rebuild sources. The behavior is
-similar for other backends.
+all generated input files, including unknown files. This is needed
+to bootstrap the generation of the real dependencies in the
+[depfile](https://ninja-build.org/manual.html#ref_headers)
+generated by your compiler to determine when to rebuild sources.
+Ninja relies on this dependency file for all input files, generated
+and non-generated. The behavior is similar for other backends.
Executable supports the following keyword arguments. Note that just
like the positional arguments above, these keyword arguments can also