diff options
| author | Eli Schwartz <eschwartz@archlinux.org> | 2022-12-14 18:55:29 -0500 |
|---|---|---|
| committer | Eli Schwartz <eschwartz@archlinux.org> | 2022-12-14 18:59:26 -0500 |
| commit | 57f91bb593b9eebf772a16a5519de58996d27c3a (patch) | |
| tree | 8e0d69abb9978c4d54c4ecd4a1fc1e68a2a28349 | |
| parent | a910e1b9713d0272c69b28ab65984fdd51e9f961 (diff) | |
| download | meson-57f91bb593b9eebf772a16a5519de58996d27c3a.tar.gz | |
docs: clarify the semantics of the required: kwarg everywhere
Link to feature options consistently, and point out that it controls
"whether" the function finds what it's trying to find. This clues people
in to the fact that disabled features exist.
| -rw-r--r-- | docs/yaml/functions/dependency.yaml | 10 | ||||
| -rw-r--r-- | docs/yaml/functions/import.yaml | 8 | ||||
| -rw-r--r-- | docs/yaml/objects/compiler.yaml | 13 |
3 files changed, 23 insertions, 8 deletions
diff --git a/docs/yaml/functions/dependency.yaml b/docs/yaml/functions/dependency.yaml index ad4e66e8c..2d9e36656 100644 --- a/docs/yaml/functions/dependency.yaml +++ b/docs/yaml/functions/dependency.yaml @@ -158,9 +158,13 @@ kwargs: type: bool | feature default: true description: | - when set to false, Meson will proceed with the build - even if the dependency is not found. *(since 0.47.0)* The value of a - [`feature`](Build-options.md#features) option can also be passed. + When set to `false`, Meson will proceed with the build + even if the dependency is not found. + + When set to a [`feature`](Build-options.md#features) option, the feature + will control if it is searched and whether to fail if not found. + + *(since 0.47.0)* The value of a `feature` option can also be passed. static: type: bool diff --git a/docs/yaml/functions/import.yaml b/docs/yaml/functions/import.yaml index 13c0a06f3..c69909d0c 100644 --- a/docs/yaml/functions/import.yaml +++ b/docs/yaml/functions/import.yaml @@ -19,8 +19,14 @@ posargs: kwargs: required: type: bool | feature + default: true since: 0.59.0 - description: Whether the mdule is required and Meson should abort if not found. + description: + When set to `false`, Meson will proceed with the build even if the module + is not found. + + When set to a [`feature`](Build-options.md#features) option, the feature + will control if it is searched and whether to fail if not found. disabler: type: bool diff --git a/docs/yaml/objects/compiler.yaml b/docs/yaml/objects/compiler.yaml index 01283cdd1..938afe39c 100644 --- a/docs/yaml/objects/compiler.yaml +++ b/docs/yaml/objects/compiler.yaml @@ -137,7 +137,11 @@ methods: type: bool | feature default: false since: 0.50.0 - description: If set to `true`, Meson will halt if the header check fails. + description: + When set to `true`, Meson will halt if the header check fails. + + When set to a [`feature`](Build-options.md#features) option, the feature + will control if it is searched and whether to fail if not found. # Star of the actual functions @@ -367,8 +371,10 @@ methods: be found. Otherwise, Meson will continue and the found method of the returned object will return `false`. - *(since 0.47.0)* The value of a [`feature`](Build-options.md#features) - option can also be passed here. + When set to a [`feature`](Build-options.md#features) option, the feature + will control if it is searched and whether to fail if not found. + + *(since 0.47.0)* The value of a `feature` option can also be passed here. has_headers: type: list[str] @@ -609,4 +615,3 @@ methods: type: list[str] description: | Extra flags to pass to the preprocessor - |