diff options
| author | unknown <vid512@gmail.com> | 2024-09-20 08:48:54 +0200 |
|---|---|---|
| committer | Dylan Baker <dylan@pnwbakers.com> | 2024-09-21 08:17:41 -0700 |
| commit | cbbe455ba4f7da2d9056023d8e8647da96eeaf09 (patch) | |
| tree | 28c972db892c1a220e0b2330f1d331b67d8b547e /docs | |
| parent | c8b463491c3dac4f21120ff9cbc2de491e2b66c9 (diff) | |
| download | meson-cbbe455ba4f7da2d9056023d8e8647da96eeaf09.tar.gz | |
Document get_variable(system)
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/markdown/Dependencies.md | 4 | ||||
| -rw-r--r-- | docs/markdown/snippets/system_variable_in_dep.md | 3 | ||||
| -rw-r--r-- | docs/yaml/objects/dep.yaml | 7 |
3 files changed, 11 insertions, 3 deletions
diff --git a/docs/markdown/Dependencies.md b/docs/markdown/Dependencies.md index a457342d1..3c3df1bcc 100644 --- a/docs/markdown/Dependencies.md +++ b/docs/markdown/Dependencies.md @@ -80,8 +80,8 @@ var = foo_dep.get_variable(cmake : 'CMAKE_VAR', pkgconfig : 'pkg-config-var', co ``` It accepts the keywords 'cmake', 'pkgconfig', 'pkgconfig_define', -'configtool', 'internal', and 'default_value'. 'pkgconfig_define' -works just like the 'define_variable' argument to +'configtool', 'internal', 'system', and 'default_value'. +'pkgconfig_define' works just like the 'define_variable' argument to `get_pkgconfig_variable`. When this method is invoked the keyword corresponding to the underlying type of the dependency will be used to look for a variable. If that variable cannot be found or if the caller diff --git a/docs/markdown/snippets/system_variable_in_dep.md b/docs/markdown/snippets/system_variable_in_dep.md new file mode 100644 index 000000000..0cd936322 --- /dev/null +++ b/docs/markdown/snippets/system_variable_in_dep.md @@ -0,0 +1,3 @@ +## Support for variable in system dependencies + +System Dependency method `get_variable()` now supports `system` variable. diff --git a/docs/yaml/objects/dep.yaml b/docs/yaml/objects/dep.yaml index 28d93d79f..ffd19f797 100644 --- a/docs/yaml/objects/dep.yaml +++ b/docs/yaml/objects/dep.yaml @@ -191,7 +191,7 @@ methods: since: 0.58.0 description: | This argument is used as a default value - for `cmake`, `pkgconfig`, `configtool` and `internal` keyword + for `cmake`, `pkgconfig`, `configtool`, `internal` and `system` keyword arguments. It is useful in the common case where `pkgconfig` and `internal` use the same variable name, in which case it's easier to write `dep.get_variable('foo')` instead of `dep.get_variable(pkgconfig: 'foo', internal: 'foo')`. @@ -214,6 +214,11 @@ methods: since: 0.54.0 description: The internal variable name + system: + type: str + since: 1.6.0 + description: The system variable name + default_value: type: str description: The default value to return when the variable does not exist |