summaryrefslogtreecommitdiffstats
path: root/Help/manual/cmake-presets.7.rst
diff options
context:
space:
mode:
authorKyle Edwards <kyle.edwards@kitware.com>2021-03-11 14:22:37 (GMT)
committerKyle Edwards <kyle.edwards@kitware.com>2021-03-15 18:41:42 (GMT)
commit79d03ab5055da1397c525c31d8cb13c30965a911 (patch)
tree483abac0254665e286f5af4b6a8a93b355dd31df /Help/manual/cmake-presets.7.rst
parent69527a1979093a5fb103c1940f0f0b17d97b45e2 (diff)
downloadCMake-79d03ab5055da1397c525c31d8cb13c30965a911.zip
CMake-79d03ab5055da1397c525c31d8cb13c30965a911.tar.gz
CMake-79d03ab5055da1397c525c31d8cb13c30965a911.tar.bz2
Help: Fix version numbers in CMakePresets.json documentation
Diffstat (limited to 'Help/manual/cmake-presets.7.rst')
-rw-r--r--Help/manual/cmake-presets.7.rst11
1 files changed, 6 insertions, 5 deletions
diff --git a/Help/manual/cmake-presets.7.rst b/Help/manual/cmake-presets.7.rst
index 3d2ada8..60d0473 100644
--- a/Help/manual/cmake-presets.7.rst
+++ b/Help/manual/cmake-presets.7.rst
@@ -39,7 +39,7 @@ The root object recognizes the following fields:
``version``
A required integer representing the version of the JSON schema.
- The supported versions are ``1`` and ``2``.
+ The supported versions are ``1``, ``2``, and ``3``.
``cmakeMinimumRequired``
@@ -70,17 +70,17 @@ The root object recognizes the following fields:
``configurePresets``
An optional array of `Configure Preset`_ objects.
- This is allowed in preset files specifying version 1 or above.
+ This is allowed in preset files specifying version ``1`` or above.
``buildPresets``
An optional array of `Build Preset`_ objects.
- This is allowed in preset files specifying version 2 or above.
+ This is allowed in preset files specifying version ``2`` or above.
``testPresets``
An optional array of `Test Preset`_ objects.
- This is allowed in preset files specifying version 2 or above.
+ This is allowed in preset files specifying version ``2`` or above.
Configure Preset
^^^^^^^^^^^^^^^^
@@ -187,7 +187,8 @@ that may contain the following fields:
An optional string representing the path to the installation directory.
This field supports `macro expansion`_. If a relative path is specified,
- it is calculated relative to the source directory.
+ it is calculated relative to the source directory. This is allowed in
+ preset files specifying version ``3`` or above.
``cmakeExecutable``