From 57f91bb593b9eebf772a16a5519de58996d27c3a Mon Sep 17 00:00:00 2001 From: Eli Schwartz Date: Wed, 14 Dec 2022 18:55:29 -0500 Subject: 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. --- docs/yaml/objects/compiler.yaml | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) (limited to 'docs/yaml/objects') 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 - -- cgit v1.2.3