1
0
mirror of https://github.com/Kitware/CMake.git synced 2025-10-22 16:07:49 +08:00

Help: Add section heading for configure presets in cmake-presets(7)

Cross-reference it from the main `configurePresets` field.
This removes an extra layer of indentation and makes the
section linkable.
This commit is contained in:
Brad King
2021-01-14 13:39:21 -05:00
parent 501bcb6327
commit 69dbaba6fb

View File

@@ -69,17 +69,22 @@ The root object recognizes the following fields:
``configurePresets``
An optional array of configure preset objects. Each preset may contain the
following fields:
An optional array of `Configure Preset`_ objects.
``name``
Configure Preset
^^^^^^^^^^^^^^^^
Each entry of the ``configurePresets`` array is a JSON object
that may contain the following fields:
``name``
A required string representing the machine-friendly name of the preset.
This identifier is used in the ``--preset`` argument. There must not be
two presets in the union of ``CMakePresets.json`` and
``CMakeUserPresets.json`` in the same directory with the same name.
``hidden``
``hidden``
An optional boolean specifying whether or not a preset should be hidden.
If a preset is hidden, it cannot be used in the ``--preset=`` argument,
@@ -88,7 +93,7 @@ The root object recognizes the following fields:
inheritance. ``hidden`` presets are intended to be used as a base for
other presets to inherit via the ``inherits`` field.
``inherits``
``inherits``
An optional array of strings representing the names of presets to inherit
from. The preset will inherit all of the fields from the ``inherits``
@@ -102,7 +107,7 @@ The root object recognizes the following fields:
This field can also be a string, which is equivalent to an array
containing one string.
``vendor``
``vendor``
An optional map containing vendor-specific information. CMake does not
interpret the contents of this field except to verify that it is a map
@@ -111,15 +116,15 @@ The root object recognizes the following fields:
``vendor`` field, they should implement inheritance in a sensible manner
when appropriate.
``displayName``
``displayName``
An optional string with a human-friendly name of the preset.
``description``
``description``
An optional string with a human-friendly description of the preset.
``generator``
``generator``
An optional string representing the generator to use for the preset. If
``generator`` is not specified, it must be inherited from the
@@ -129,8 +134,8 @@ The root object recognizes the following fields:
argument, you cannot include the platform name in the generator name. Use
the ``architecture`` field instead.
``architecture``
``toolset``
``architecture``
``toolset``
Optional fields representing the platform and toolset, respectively, for
generators that support them. Each may be either a string or an object
@@ -159,7 +164,7 @@ The root object recognizes the following fields:
ignore the field, but the IDE can use them to set up the environment
before invoking CMake.
``binaryDir``
``binaryDir``
An optional string representing the path to the output binary directory.
This field supports `macro expansion`_. If a relative path is specified,
@@ -167,13 +172,13 @@ The root object recognizes the following fields:
specified, it must be inherited from the ``inherits`` preset (unless this
preset is ``hidden``).
``cmakeExecutable``
``cmakeExecutable``
An optional string representing the path to the CMake executable to use
for this preset. This is reserved for use by IDEs, and is not used by
CMake itself. IDEs that use this field should expand any macros in it.
``cacheVariables``
``cacheVariables``
An optional map of cache variables. The key is the variable name (which
may not be an empty string), and the value is either ``null``, a boolean
@@ -198,7 +203,7 @@ The root object recognizes the following fields:
applied. Setting a variable to ``null`` causes it to not be set, even if
a value was inherited from another preset.
``environment``
``environment``
An optional map of environment variables. The key is the variable name
(which may not be an empty string), and the value is either ``null`` or
@@ -216,7 +221,7 @@ The root object recognizes the following fields:
applied. Setting a variable to ``null`` causes it to not be set, even if
a value was inherited from another preset.
``warnings``
``warnings``
An optional object specifying the warnings to enable. The object may
contain the following fields:
@@ -248,7 +253,7 @@ The root object recognizes the following fields:
An optional boolean. Setting this to ``true`` is equivalent to passing
``--check-system-vars`` on the command line.
``errors``
``errors``
An optional object specifying the errors to enable. The object may
contain the following fields:
@@ -265,7 +270,7 @@ The root object recognizes the following fields:
``-Wno-error=deprecated`` on the command line. This may not be set to
``true`` if ``warnings.deprecated`` is set to ``false``.
``debug``
``debug``
An optional object specifying debug options. The object may contain the
following fields: