mirror/CMake
1
0
Fork 0
mirror of https://github.com/Kitware/CMake.git synced 2026-01-06 05:40:54 -06:00
Code Issues Packages Projects Releases Wiki Activity

Merge topic 'doc-presets' into release-3.25

Browse Source 
8a413eb8d0 Help: State default preset strategy for architecture and toolset
8de977fa70 Help: Use array consistently in presets manual
e11773e8cf Help: Fix trivial typos related to presets

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !7817
This commit is contained in:
Brad King
2022-10-25 14:37:11 +00:00
committed by Kitware Robot
parent 32386d7c01 8a413eb8d0
commit 19f49a7514
2 changed files with 12 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -161,7 +161,7 @@ that may contain the following fields:
presets by default (except ``name``, ``hidden``, ``inherits``,
``description``, and ``displayName``), but can override them as
desired. If multiple ``inherits`` presets provide conflicting values for
the same field, the earlier preset in the ``inherits`` list will be
the same field, the earlier preset in the ``inherits`` array will be
preferred.
A preset can only inherit from another preset that is defined in the
@@ -202,7 +202,7 @@ that may contain the following fields:
Optional fields representing the platform and toolset, respectively, for
:manual:`generators <cmake-generators(7)>` that support them.
See :option:`cmake -A` option for for possible values for ``architecture``
See :option:`cmake -A` option for possible values for ``architecture``
and :option:`cmake -T` for ``toolset``.
Each may be either a string or an object with the following fields:
@@ -226,6 +226,9 @@ that may contain the following fields:
ignore the field, but the IDE can use them to set up the environment
before invoking CMake.
If no ``strategy`` field is given, or if the field uses the string form
rather than the object form, the behavior is the same as ``"set"``.
``toolchainFile``
An optional string representing the path to the toolchain file.
This field supports `macro expansion`_. If a relative path is specified,
@@ -388,7 +391,7 @@ that may contain the following fields:
``inherits`` presets by default (except ``name``, ``hidden``,
``inherits``, ``description``, and ``displayName``), but can override
them as desired. If multiple ``inherits`` presets provide conflicting
values for the same field, the earlier preset in the ``inherits`` list
values for the same field, the earlier preset in the ``inherits`` array
will be preferred.
A preset can only inherit from another preset that is defined in the
@@ -549,7 +552,7 @@ that may contain the following fields:
``inherits`` presets by default (except ``name``, ``hidden``,
``inherits``, ``description``, and ``displayName``), but can override
them as desired. If multiple ``inherits`` presets provide conflicting
values for the same field, the earlier preset in the ``inherits`` list
values for the same field, the earlier preset in the ``inherits`` array
will be preferred.
A preset can only inherit from another preset that is defined in the
@@ -891,7 +894,7 @@ fields:
``inherits`` presets by default (except ``name``, ``hidden``,
``inherits``, ``description``, and ``displayName``), but can override
them as desired. If multiple ``inherits`` presets provide conflicting
values for the same field, the earlier preset in the ``inherits`` list
values for the same field, the earlier preset in the ``inherits`` array
will be preferred.
A preset can only inherit from another preset that is defined in the
@@ -948,10 +951,10 @@ fields:
explicitly specified in this package preset.
``generators``
An optional list of strings representing generators for CPack to use.
An optional array of strings representing generators for CPack to use.
``configurations``
An optional list of strings representing build configurations for CPack to
An optional array of strings representing build configurations for CPack to
package.
``variables``
@@ -1073,7 +1076,7 @@ object, it has the following fields:
A required string to search for. This field supports macro expansion.
``list``
A required list of strings to search. This field supports macro
A required array of strings to search. This field supports macro
expansion, and uses short-circuit evaluation.
``"matches"``

2
Help/release/3.25.rst
View File

@@ -21,7 +21,7 @@ Presets
* The :manual:`cmake-presets(7)` format now supports a
``workflowPresets`` field to specify presets for :option:`cmake --workflow`.
* The :manual:`cmake-presets(7)` format now supports a
* The :manual:`cmake-presets(7)` format now supports an
``outputJUnitFile`` field to specify JUnit output in test presets.
Languages