summaryrefslogtreecommitdiffstats
path: root/Help/manual
diff options
context:
space:
mode:
authorKyle Edwards <kyle.edwards@kitware.com>2020-10-22 15:04:13 (GMT)
committerKitware Robot <kwrobot@kitware.com>2020-10-22 15:04:19 (GMT)
commit6abe14d2263476755364ef5017cc6b25b42a9ed5 (patch)
tree66189aa62b69d47ce196692dfa82b1f5ff8b7c25 /Help/manual
parent504aadf414d6c53c9eeb0c74b1a4b5438e0e5c3d (diff)
parent920d18004731c97a828a937e2074b6882ffeb20d (diff)
downloadCMake-6abe14d2263476755364ef5017cc6b25b42a9ed5.zip
CMake-6abe14d2263476755364ef5017cc6b25b42a9ed5.tar.gz
CMake-6abe14d2263476755364ef5017cc6b25b42a9ed5.tar.bz2
Merge topic 'cmake-presets-boolean-cache'
920d180047 CMakePresets.json: Allow boolean for cache variable value Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !5398
Diffstat (limited to 'Help/manual')
-rw-r--r--Help/manual/cmake-presets.7.rst10
-rw-r--r--Help/manual/presets/schema.json16
2 files changed, 20 insertions, 6 deletions
diff --git a/Help/manual/cmake-presets.7.rst b/Help/manual/cmake-presets.7.rst
index 93e1151..7040ad5 100644
--- a/Help/manual/cmake-presets.7.rst
+++ b/Help/manual/cmake-presets.7.rst
@@ -176,9 +176,10 @@ Format
``cacheVariables``
An optional map of cache variables. The key is the variable name (which
- may not be an empty string), and the value is either ``null``, a string
- representing the value of the variable (which supports macro expansion),
- or an object with the following fields:
+ may not be an empty string), and the value is either ``null``, a boolean
+ (which is equivalent to a value of ``"TRUE"`` or ``"FALSE"`` and a type
+ of ``BOOL``), a string representing the value of the variable (which
+ supports macro expansion), or an object with the following fields:
``type``
@@ -186,7 +187,8 @@ Format
``value``
- A required string representing the value of the variable. This field
+ A required string or boolean representing the value of the variable.
+ A boolean is equivalent to ``"TRUE"`` or ``"FALSE"``. This field
supports macro expansion.
Cache variables are inherited through the ``inherits`` field, and the
diff --git a/Help/manual/presets/schema.json b/Help/manual/presets/schema.json
index 564c94c..ba4568f 100644
--- a/Help/manual/presets/schema.json
+++ b/Help/manual/presets/schema.json
@@ -119,6 +119,10 @@
"description": "Setting a variable to null causes it to not be set, even if a value was inherited from another preset."
},
{
+ "type": "boolean",
+ "description": "A boolean representing the value of the variable. Equivalent to \"TRUE\" or \"FALSE\"."
+ },
+ {
"type": "string",
"description": "A string representing the value of the variable (which supports macro expansion)."
},
@@ -131,8 +135,16 @@
"description": "An optional string representing the type of the variable. It should be BOOL, FILEPATH, PATH, STRING, or INTERNAL."
},
"value": {
- "type": "string",
- "description": "A required string representing the value of the variable. This field supports macro expansion."
+ "anyOf": [
+ {
+ "type": "boolean",
+ "description": "A required boolean representing the value of the variable. Equivalent to \"TRUE\" or \"FALSE\"."
+ },
+ {
+ "type": "string",
+ "description": "A required string representing the value of the variable. This field supports macro expansion."
+ }
+ ]
}
},
"required": [