Kitware/CMake
1
0
Fork 0
mirror of https://github.com/Kitware/CMake.git synced 2025-10-16 22:37:30 +08:00
Code Issues Projects Releases Wiki Activity

Help: Fix version numbers in CMakePresets.json documentation

Browse Source
This commit is contained in:
Kyle Edwards
2021-03-11 09:22:37 -05:00
parent 69527a1979
commit 79d03ab505
1 changed files with 6 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
Help/manual/cmake-presets.7.rst
View File

@@ -39,7 +39,7 @@ The root object recognizes the following fields:
``version`` ``version``
A required integer representing the version of the JSON schema. 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`` ``cmakeMinimumRequired``
@@ -70,17 +70,17 @@ The root object recognizes the following fields:
``configurePresets`` ``configurePresets``
An optional array of `Configure Preset`_ objects. 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`` ``buildPresets``
An optional array of `Build Preset`_ objects. 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`` ``testPresets``
An optional array of `Test Preset`_ objects. 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 Configure Preset
^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^
@@ -187,7 +187,8 @@ that may contain the following fields:
An optional string representing the path to the installation directory. An optional string representing the path to the installation directory.
This field supports `macro expansion`_. If a relative path is specified, 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`` ``cmakeExecutable``