aboutsummaryrefslogtreecommitdiff
path: root/docs/markdown
diff options
context:
space:
mode:
authorJon Turney <jon.turney@dronecode.org.uk>2018-05-22 20:18:12 +0100
committerNirbheek Chauhan <nirbheek.chauhan@gmail.com>2018-05-31 13:15:47 +0000
commit809336833cbc5cec2656f32d03e9221fc5406cb3 (patch)
tree097681154f1dd7635579e7a58205d8f84fe7ee1b /docs/markdown
parent82c81a5d82cec642a738f234d99982c3c75568a3 (diff)
downloadmeson-809336833cbc5cec2656f32d03e9221fc5406cb3.zip
meson-809336833cbc5cec2656f32d03e9221fc5406cb3.tar.gz
meson-809336833cbc5cec2656f32d03e9221fc5406cb3.tar.bz2
Improve dependency() documentation [skip ci]
Mention that the dependency name will also be searched for as a framework on OSX. Note that additional dependency-specific keywords may be used by custom dependency lookup.
Diffstat (limited to 'docs/markdown')
-rw-r--r--docs/markdown/Reference-manual.md14
1 files changed, 8 insertions, 6 deletions
diff --git a/docs/markdown/Reference-manual.md b/docs/markdown/Reference-manual.md
index e29f4d9..3f1bb50 100644
--- a/docs/markdown/Reference-manual.md
+++ b/docs/markdown/Reference-manual.md
@@ -310,8 +310,9 @@ keyword arguments.
```
Finds an external dependency (usually a library installed on your
-system) with the given name with `pkg-config` if possible and with
-[library-specific fallback detection logic](Dependencies.md)
+system) with the given name with `pkg-config` if possible, as a
+framework (OSX only), and with
+[library-specific fallback detection logic](Dependencies.md#dependencies-with-custom-lookup-functionality)
otherwise. This function supports the following keyword arguments:
- `default_options` *(added 0.37.0)* an array of default option values
@@ -331,8 +332,6 @@ otherwise. This function supports the following keyword arguments:
`auto` but can be overridden to be e.g. `qmake` for Qt development,
and different dependencies support different values for this (though
`auto` will work on all of them)
-- `modules` specifies submodules to use for dependencies such as Qt5
- or Boost.
- `native` if set to `true`, causes Meson to find the dependency on
the build machine system rather than the host system (i.e. where the
cross compiled binary will run on), usually only needed if you build
@@ -347,9 +346,12 @@ otherwise. This function supports the following keyword arguments:
`>1.0.0`, `<=2.3.5` or `3.1.4` for exact matching. (*Added 0.37.0*)
You can also specify multiple restrictions by passing a list to this
keyword argument, such as: `['>=3.14.0', '<=4.1.0']`.
-- `private_headers`, only available with Qt modules see [documentation](Qt5-module.md#private_headers).
+- other
+[library-specific](Dependencies.md#dependencies-with-custom-lookup-functionality)
+keywords may also be accepted (e.g. `modules` specifies submodules to use for
+dependencies such as Qt5 or Boost. )
-If dependency_name is '', the dependency is always not found. So with
+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