summaryrefslogtreecommitdiffstats
path: root/Help
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2021-02-19 14:34:29 (GMT)
committerKitware Robot <kwrobot@kitware.com>2021-02-19 14:34:35 (GMT)
commitc8ff06a1f8a31782ca314072fa0f98f953f97305 (patch)
treed0eeebfbb6aad25a9dc2a477baf1029d3bd770d1 /Help
parent5f32d8a4e129f40d9017a065cd0449423a992d25 (diff)
parent87b170d9f9bdbcf4249e709864d90efce151883a (diff)
downloadCMake-c8ff06a1f8a31782ca314072fa0f98f953f97305.zip
CMake-c8ff06a1f8a31782ca314072fa0f98f953f97305.tar.gz
CMake-c8ff06a1f8a31782ca314072fa0f98f953f97305.tar.bz2
Merge topic 'docpreset' into release-3.20
87b170d9f9 Help: Add build and test preset to examples in cmake-presets(7) 3f8cf006cb Help: Clarify preset name conflict rules in cmake-presets(7) Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !5823
Diffstat (limited to 'Help')
-rw-r--r--Help/manual/cmake-presets.7.rst17
-rw-r--r--Help/manual/presets/example.json18
2 files changed, 25 insertions, 10 deletions
diff --git a/Help/manual/cmake-presets.7.rst b/Help/manual/cmake-presets.7.rst
index ac3ecf5..55a9947 100644
--- a/Help/manual/cmake-presets.7.rst
+++ b/Help/manual/cmake-presets.7.rst
@@ -95,8 +95,9 @@ that may contain the following fields:
A required string representing the machine-friendly name of the preset.
This identifier is used in the :ref:`cmake --preset <CMake Options>` option.
- There must not be two presets in the union of ``CMakePresets.json`` and
- ``CMakeUserPresets.json`` in the same directory with the same name.
+ There must not be two configure presets in the union of ``CMakePresets.json``
+ and ``CMakeUserPresets.json`` in the same directory with the same name.
+ However, a configure preset may have the same name as a build or test preset.
``hidden``
@@ -314,9 +315,9 @@ that may contain the following fields:
A required string representing the machine-friendly name of the preset.
This identifier is used in the
:ref:`cmake --build --preset <Build Tool Mode>` option.
- There must not be two presets (configure, build, or test) in the union of
- ``CMakePresets.json`` and ``CMakeUserPresets.json`` in the same
- directory with the same name.
+ There must not be two build presets in the union of ``CMakePresets.json``
+ and ``CMakeUserPresets.json`` in the same directory with the same name.
+ However, a build preset may have the same name as a configure or test preset.
``hidden``
@@ -433,9 +434,9 @@ that may contain the following fields:
A required string representing the machine-friendly name of the preset.
This identifier is used in the :ref:`ctest --preset <CTest Options>` option.
- There must not be two presets (configure, build, or test) in the union of
- ``CMakePresets.json`` and ``CMakeUserPresets.json`` in the same
- directory with the same name.
+ There must not be two test presets in the union of ``CMakePresets.json``
+ and ``CMakeUserPresets.json`` in the same directory with the same name.
+ However, a test preset may have the same name as a configure or build preset.
``hidden``
diff --git a/Help/manual/presets/example.json b/Help/manual/presets/example.json
index d3b6f4a..dfc2910 100644
--- a/Help/manual/presets/example.json
+++ b/Help/manual/presets/example.json
@@ -1,8 +1,8 @@
{
- "version": 1,
+ "version": 2,
"cmakeMinimumRequired": {
"major": 3,
- "minor": 19,
+ "minor": 20,
"patch": 0
},
"configurePresets": [
@@ -37,6 +37,20 @@
"generator": "Ninja Multi-Config"
}
],
+ "buildPresets": [
+ {
+ "name": "default",
+ "configurePreset": "default"
+ }
+ ],
+ "testPresets": [
+ {
+ "name": "default",
+ "configurePreset": "default",
+ "output": {"outputOnFailure": true},
+ "execution": {"noTestsAction": "error", "stopOnFailure": true}
+ }
+ ],
"vendor": {
"example.com/ExampleIDE/1.0": {
"autoFormat": false