diff options
author | Dylan Baker <dylan@pnwbakers.com> | 2020-01-07 11:43:31 -0800 |
---|---|---|
committer | Dylan Baker <dylan@pnwbakers.com> | 2020-01-09 11:02:17 -0800 |
commit | 202c89d0b665a536a738c59dcde1f374047a346e (patch) | |
tree | 80272f741d850048230f86253ddd37621d0fc10b /docs/markdown/Subprojects.md | |
parent | cd895be99a7917e8c052ec7bb6088704c87783ae (diff) | |
download | meson-202c89d0b665a536a738c59dcde1f374047a346e.zip meson-202c89d0b665a536a738c59dcde1f374047a346e.tar.gz meson-202c89d0b665a536a738c59dcde1f374047a346e.tar.bz2 |
docs: Add documentation for variables keyword
In declare_dependency() and dependency.get_variables().
Diffstat (limited to 'docs/markdown/Subprojects.md')
-rw-r--r-- | docs/markdown/Subprojects.md | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/docs/markdown/Subprojects.md b/docs/markdown/Subprojects.md index 91b1843..8232da9 100644 --- a/docs/markdown/Subprojects.md +++ b/docs/markdown/Subprojects.md @@ -55,6 +55,28 @@ should be named as `<project_name>_dep` (e.g. `gtest_dep`), and others can have There may be exceptions to these rules where common sense should be applied. +### Adding variables to the dependency + +*New in 0.54.0* + +In some cases a project may define special variables via pkg-config or cmake +that a caller needs to know about. Meson provides a `dependency.get_variable` +method to hide what kind of dependency is provided, and this is available to +subprojects as well. Use the `variables` keyword to add a dict of strings: + +```meson +my_dep = declare_dependency(..., variables : {'var': 'value', 'number': '3'}) +``` + +Which another project can access via: + +```meson +var = my_dep.get_variable(internal : 'var', cmake : 'CMAKE_VAR') +``` + +The values of the dict must be strings, as pkg-config and cmake will return +variables as strings. + ### Build options in subproject All Meson features of the subproject, such as project options keep |