diff options
| author | Eli Schwartz <eschwartz@archlinux.org> | 2021-11-09 18:12:32 -0500 |
|---|---|---|
| committer | Xavier Claessens <xclaesse@gmail.com> | 2021-11-09 16:59:36 -0800 |
| commit | 39ceb677744e1f959a0db6406d51a26d78f0ab68 (patch) | |
| tree | e4e6d708e2487f2ce50b9de6d15302d1e787ab13 /docs | |
| parent | 4029705cf3f9c5155f9a8545c7a85b3b550466d3 (diff) | |
| download | meson-39ceb677744e1f959a0db6406d51a26d78f0ab68.zip meson-39ceb677744e1f959a0db6406d51a26d78f0ab68.tar.gz meson-39ceb677744e1f959a0db6406d51a26d78f0ab68.tar.bz2 | |
docs: fix refman 2.0 regression in correctly describing find_library(has_headers)
All kwargs inherited from has_header need to be prefixed `header_` so we
cannot just do straight inheritance. And the part of the description
that highlighted the way kwargs are derived and evolved, went entirely
missing.
Fixes #9551
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/yaml/objects/compiler.yaml | 39 |
1 files changed, 37 insertions, 2 deletions
diff --git a/docs/yaml/objects/compiler.yaml b/docs/yaml/objects/compiler.yaml index ccce489..4cdeb54 100644 --- a/docs/yaml/objects/compiler.yaml +++ b/docs/yaml/objects/compiler.yaml @@ -352,7 +352,6 @@ methods: returns: dep description: Tries to find the library specified in the positional argument. - kwargs_inherit: compiler._common posargs: libname: type: str @@ -377,6 +376,10 @@ methods: This check is equivalent to checking each header with a [[compiler.has_header]] call. + When used, kwargs that [[compiler.has_header]] would accept can be + passed here prefixed with `header_`, and will have the same effect on + the header check. + static: type: bool default: false @@ -400,7 +403,39 @@ methods: By default the library is searched for in the system library directory (e.g. /usr/lib). Specifying more directories here, causes Meson to search in those directories as well as the system directories. - +# does not work, since all _common kwargs need to be prefixed `header_` here +# kwargs_inherit: compiler._common + header_args: + type: list[str] + since: 0.51.0 + description: | + When the `has_headers` kwarg is also used, this argument is passed to + [[compiler.has_header]] as `args`. + header_include_directories: + type: inc | list[inc] + since: 0.51.0 + description: | + When the `has_headers` kwarg is also used, this argument is passed to + [[compiler.has_header]] as `include_directories`. + header_dependencies: + type: dep | list[dep] + since: 0.51.0 + description: | + When the `has_headers` kwarg is also used, this argument is passed to + [[compiler.has_header]] as `dependencies`. + header_no_builtin_args: + type: bool + default: false + since: 0.51.0 + description: | + When the `has_headers` kwarg is also used, this argument is passed to + [[compiler.has_header]] as `no_builtin_args`. + header_prefix: + type: str + since: 0.51.0 + description: | + When the `has_headers` kwarg is also used, this argument is passed to + [[compiler.has_header]] as `prefix`. # Compiler arguments - name: has_argument |