diff options
| author | Jan Janssen <medhefgo@web.de> | 2023-08-11 12:26:27 +0200 |
|---|---|---|
| committer | Xavier Claessens <xclaesse@gmail.com> | 2023-08-11 08:33:00 -0400 |
| commit | 03a2a3a6773785e087b296e9e6ff6791c6068f60 (patch) | |
| tree | d4ac4a92892ae72e604b1dd4d2bc3d0990787a71 /docs | |
| parent | 32e7ebc821a2078722947c5bd412b6c0a244b30d (diff) | |
| download | meson-03a2a3a6773785e087b296e9e6ff6791c6068f60.zip meson-03a2a3a6773785e087b296e9e6ff6791c6068f60.tar.gz meson-03a2a3a6773785e087b296e9e6ff6791c6068f60.tar.bz2 | |
docs: Add more feature truth tables
These are much easier to understand at a glance than free-form text.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/yaml/objects/feature.yaml | 38 |
1 files changed, 28 insertions, 10 deletions
diff --git a/docs/yaml/objects/feature.yaml b/docs/yaml/objects/feature.yaml index 3e37644..26b677f 100644 --- a/docs/yaml/objects/feature.yaml +++ b/docs/yaml/objects/feature.yaml @@ -27,11 +27,11 @@ methods: description: | Returns the feature, with `'auto'` converted to `'disabled'` if value is true. - | Feature / Condition | `value = true` | `value = false` | - | ------------------- | -------------- | --------------- | - | Enabled | Enabled | Enabled | - | Disabled | Disabled | Disabled | - | Auto | Disabled | Auto | + | Feature | `value = true` | `value = false` | + | -------- | -------------- | --------------- | + | Auto | Disabled | Auto | + | Enabled | Enabled | Enabled | + | Disabled | Disabled | Disabled | posargs: value: @@ -44,11 +44,11 @@ methods: description: | Returns the feature, with `'auto'` converted to `'enabled'` if value is true. - | Feature / Condition | `value = true` | `value = false` | - | ------------------- | -------------- | --------------- | - | Enabled | Enabled | Enabled | - | Disabled | Disabled | Disabled | - | Auto | Enabled | Auto | + | Feature | `value = true` | `value = false` | + | -------- | -------------- | --------------- | + | Auto | Enabled | Auto | + | Enabled | Enabled | Enabled | + | Disabled | Disabled | Disabled | posargs: value: @@ -63,6 +63,12 @@ methods: `'enabled'` and the value is false; a disabled feature if the object is `'auto'` or `'disabled'` and the value is false. + | Feature | `value = true` | `value = false` | + | -------- | -------------- | --------------- | + | Auto | Auto | Disabled | + | Enabled | Enabled | Error | + | Disabled | Disabled | Disabled | + example: | `require` is useful to restrict the applicability of `'auto'` features, for example based on other features or on properties of the host machine: @@ -94,6 +100,12 @@ methods: `'disabled'` and the value is true; an enabled feature if the object is `'auto'` or `'enabled'` and the value is true. + | Feature | `value = true` | `value = false` | + | -------- | -------------- | --------------- | + | Auto | Enabled | Auto | + | Enabled | Enabled | Enabled | + | Disabled | Error | Disabled | + example: | `enable_if` is useful to restrict the applicability of `'auto'` features, particularly when passing them to [[dependency]]: @@ -122,6 +134,12 @@ methods: `'enabled'` and the value is true; a disabled feature if the object is `'auto'` or `'disabled'` and the value is true. + | Feature | `value = true` | `value = false` | + | -------- | -------------- | --------------- | + | Auto | Disabled | Auto | + | Enabled | Error | Enabled | + | Disabled | Disabled | Disabled | + This is equivalent to `feature_opt.require(not condition)`, but may make code easier to reason about, especially when mixed with `enable_if` |