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

Help: Use array consistently in presets manual

Browse Source 
When referring to data in a JSON array, use "array" consistently
rather than "list". This avoids ambiguity over whether we mean
a string containing a CMake list, or a JSON array.

Fixes: #24074
This commit is contained in:
Craig Scott
2022-10-22 16:18:45 +11:00
parent e11773e8cf
commit 8de977fa70
1 changed files with 7 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
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``, presets by default (except ``name``, ``hidden``, ``inherits``,
``description``, and ``displayName``), but can override them as ``description``, and ``displayName``), but can override them as
desired. If multiple ``inherits`` presets provide conflicting values for 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. preferred.
A preset can only inherit from another preset that is defined in the A preset can only inherit from another preset that is defined in the
@@ -388,7 +388,7 @@ that may contain the following fields:
``inherits`` presets by default (except ``name``, ``hidden``, ``inherits`` presets by default (except ``name``, ``hidden``,
``inherits``, ``description``, and ``displayName``), but can override ``inherits``, ``description``, and ``displayName``), but can override
them as desired. If multiple ``inherits`` presets provide conflicting 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. will be preferred.
A preset can only inherit from another preset that is defined in the A preset can only inherit from another preset that is defined in the
@@ -549,7 +549,7 @@ that may contain the following fields:
``inherits`` presets by default (except ``name``, ``hidden``, ``inherits`` presets by default (except ``name``, ``hidden``,
``inherits``, ``description``, and ``displayName``), but can override ``inherits``, ``description``, and ``displayName``), but can override
them as desired. If multiple ``inherits`` presets provide conflicting 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. will be preferred.
A preset can only inherit from another preset that is defined in the A preset can only inherit from another preset that is defined in the
@@ -891,7 +891,7 @@ fields:
``inherits`` presets by default (except ``name``, ``hidden``, ``inherits`` presets by default (except ``name``, ``hidden``,
``inherits``, ``description``, and ``displayName``), but can override ``inherits``, ``description``, and ``displayName``), but can override
them as desired. If multiple ``inherits`` presets provide conflicting 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. will be preferred.
A preset can only inherit from another preset that is defined in the A preset can only inherit from another preset that is defined in the
@@ -948,10 +948,10 @@ fields:
explicitly specified in this package preset. explicitly specified in this package preset.
``generators`` ``generators``
An optional list of strings representing generators for CPack to use. An optional array of strings representing generators for CPack to use.
``configurations`` ``configurations``
An optional list of strings representing build configurations for CPack to An optional array of strings representing build configurations for CPack to
package. package.
``variables`` ``variables``
@@ -1073,7 +1073,7 @@ object, it has the following fields:
A required string to search for. This field supports macro expansion. A required string to search for. This field supports macro expansion.
``list`` ``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. expansion, and uses short-circuit evaluation.
``"matches"`` ``"matches"``