aboutsummaryrefslogtreecommitdiff
path: root/docs/markdown
diff options
context:
space:
mode:
authorJon Turney <jon.turney@dronecode.org.uk>2017-10-20 18:07:59 +0100
committerJussi Pakkanen <jpakkane@gmail.com>2017-12-05 01:04:57 +0200
commit87e6201214eda0941d2a2279e12a575fc27d21bb (patch)
treeaa348795b444b7120bbf14ebf663648ac95e79c1 /docs/markdown
parent6d03111638f9514ad7f5391006dca2d06aa92b84 (diff)
downloadmeson-87e6201214eda0941d2a2279e12a575fc27d21bb.zip
meson-87e6201214eda0941d2a2279e12a575fc27d21bb.tar.gz
meson-87e6201214eda0941d2a2279e12a575fc27d21bb.tar.bz2
Document and improve not-found dependency objects
Document dependency('', required:false) usage. Avoid emitting 'Dependency found: NO'.
Diffstat (limited to 'docs/markdown')
-rw-r--r--docs/markdown/Reference-manual.md12
1 files changed, 8 insertions, 4 deletions
diff --git a/docs/markdown/Reference-manual.md b/docs/markdown/Reference-manual.md
index e6aa9d3..4be06c4 100644
--- a/docs/markdown/Reference-manual.md
+++ b/docs/markdown/Reference-manual.md
@@ -316,6 +316,13 @@ otherwise. This function supports the following keyword arguments:
You can also specify multiple restrictions by passing a list to this
keyword argument, such as: `['>=3.14.0', '<=4.1.0']`.
+If dependency_name is '', the dependency is always not found. So with
+`required: false`, this always returns a dependency object for which the
+`found()` method returns `false`, and which can be passed like any other
+dependency to the `dependencies:` keyword argument of a `build_target`. This
+can be used to implement a dependency which is sometimes not required e.g. in
+some branches of a conditional.
+
The returned object also has methods that are documented in the
[object methods section](#dependency-object) below.
@@ -436,10 +443,7 @@ be passed to [shared and static libraries](#library).
The list of `sources`, `objects`, and `dependencies` is always
flattened, which means you can freely nest and add lists while
-creating the final list. As a corollary, the best way to handle a
-'disabled dependency' is by assigning an empty list `[]` to it and
-passing it like any other dependency to the `dependencies:` keyword
-argument.
+creating the final list.
The returned object also has methods that are documented in the
[object methods section](#build-target-object) below.