mirror of
https://gitlab.kitware.com/cmake/cmake.git
synced 2026-09-25 04:09:36 +03:00
Help: Generate presets JSON schema, documentation
Replace the CMake presets schema.json with a YAML document, from which both the JSON schema and (most of) the reST documentation are generated. This achieves three main goals. First, the YAML document is much closer to being human-readable than the JSON schema. Second, the JSON and reST prose (when the latter differs) are contained in the same file, in most cases adjacent (and at worst, still nearby) rather than in separate files, which should greatly facilitate keeping the two in sync. Third, changes are monumentally easier, as changes merely need to annotate the version(s) to which variants apply, rather than creating entirely separate schema trees for each variant. Since requiring Python as part of the build process is not desired, the outputs are kept in the source repository. This is consistent with other areas which are seldom updated and require special tools, such as the lexer. While this does not represent any functional change for users, some grammatical edits and other such editorial improvements have been made in the process of transferring everything to the new YAML. However, these are mainly incidental rather than representative of an attempt at a thorough editorial pass. Finally, for clarity, monkey-patch `sphing.domains.changesets` and add additional 'version modified' directives with slightly tweaked text to identify changes to the presets schema. These are nearly identical to the built-in directives, but use the text 'in presets version N' rather than 'in version N[.N]'.
This commit is contained in:
Matthew Woehlke
+103
-1144
@@ -21,7 +21,7 @@ supports files included with the ``include`` field.
|
||||
|
||||
``CMakePresets.json`` and ``CMakeUserPresets.json`` live in the project's root
|
||||
directory. They both have exactly the same format, and both are optional
|
||||
(though at least one must be present if :option:`--preset <cmake --preset>`
|
||||
(though at least one must be present if :cmake-option:`--preset`
|
||||
is specified). ``CMakePresets.json`` is meant to specify project-wide build
|
||||
details, while ``CMakeUserPresets.json`` is meant for developers to specify
|
||||
their own local build details.
|
||||
@@ -39,72 +39,14 @@ The files are a JSON document with an object as the root:
|
||||
.. literalinclude:: presets/example.json
|
||||
:language: json
|
||||
|
||||
Preset files specifying version ``10`` or above may include comments using the
|
||||
key ``$comment`` at any level within the JSON object to provide documentation.
|
||||
.. presets-versionadded:: 10
|
||||
|
||||
Preset files may include comments using the key ``$comment`` at any level
|
||||
within the JSON object to provide documentation.
|
||||
|
||||
The root object recognizes the following fields:
|
||||
|
||||
.. _`CMakePresets schema`:
|
||||
|
||||
``$schema``
|
||||
An optional string that provides a URI to the JSON schema that describes the
|
||||
structure of this JSON document. This field is used for validation and
|
||||
autocompletion in editors that support JSON schema. It doesn't affect the
|
||||
behavior of the document itself. If this field is not specified, the JSON
|
||||
document will still be valid, but tools that use JSON schema for validation
|
||||
and autocompletion may not function correctly.
|
||||
|
||||
``version``
|
||||
A required integer representing the version of the JSON schema. See
|
||||
`Versions`_ for discussion of the supported versions and the corresponding
|
||||
version of CMake in which they were added.
|
||||
|
||||
``cmakeMinimumRequired``
|
||||
An optional object representing the minimum version of CMake needed to
|
||||
build this project. This object consists of the following fields:
|
||||
|
||||
``major``
|
||||
An optional integer representing the major version.
|
||||
|
||||
``minor``
|
||||
An optional integer representing the minor version.
|
||||
|
||||
``patch``
|
||||
An optional integer representing the patch version.
|
||||
|
||||
``include``
|
||||
An optional array of strings representing files to include. If the filenames
|
||||
are not absolute, they are considered relative to the current file.
|
||||
This is allowed in preset files specifying version ``4`` or above.
|
||||
See `Includes`_ for discussion of the constraints on included files.
|
||||
|
||||
``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 if
|
||||
it does exist. However, the keys should be a vendor-specific domain name
|
||||
followed by a ``/``-separated path. For example, the Example IDE 1.0 could
|
||||
use ``example.com/ExampleIDE/1.0``. The value of each field can be anything
|
||||
desired by the vendor, though will typically be a map.
|
||||
|
||||
``configurePresets``
|
||||
An optional array of `Configure Preset`_ objects.
|
||||
This is allowed in preset files specifying version ``1`` or above.
|
||||
|
||||
``buildPresets``
|
||||
An optional array of `Build Preset`_ objects.
|
||||
This is allowed in preset files specifying version ``2`` or above.
|
||||
|
||||
``testPresets``
|
||||
An optional array of `Test Preset`_ objects.
|
||||
This is allowed in preset files specifying version ``2`` or above.
|
||||
|
||||
``packagePresets``
|
||||
An optional array of `Package Preset`_ objects.
|
||||
This is allowed in preset files specifying version ``6`` or above.
|
||||
|
||||
``workflowPresets``
|
||||
An optional array of `Workflow Preset`_ objects.
|
||||
This is allowed in preset files specifying version ``6`` or above.
|
||||
.. include:: presets/root-properties.rst
|
||||
|
||||
Includes
|
||||
^^^^^^^^
|
||||
@@ -126,11 +68,18 @@ Files directly or indirectly included from ``CMakePresets.json`` should be
|
||||
guaranteed to be provided by the project. ``CMakeUserPresets.json`` may
|
||||
include files from anywhere.
|
||||
|
||||
Starting from version ``7``, the ``include`` field supports
|
||||
`macro expansion`_, but only ``$penv{}`` macro expansion. Starting from version
|
||||
``9``, other macro expansions are also available, except for ``$env{}`` and
|
||||
preset-specific macros, i.e., those derived from the fields inside a preset's
|
||||
definition like ``presetName``.
|
||||
.. presets-versionchanged:: 7
|
||||
|
||||
The ``include`` field supports `macro expansion`_, but only ``$penv{}`` macro
|
||||
expansion.
|
||||
|
||||
.. presets-versionchanged:: 9
|
||||
|
||||
The ``include`` field supports `macro expansion`_, except for ``$env{}`` and
|
||||
preset-specific macros (i.e., those derived from the fields inside a preset's
|
||||
definition like ``presetName``).
|
||||
|
||||
.. _`Configure Preset`:
|
||||
|
||||
Configure Preset
|
||||
^^^^^^^^^^^^^^^^
|
||||
@@ -138,1062 +87,69 @@ 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 :option:`cmake --preset` option.
|
||||
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, test,
|
||||
package, or workflow preset.
|
||||
.. include:: presets/configurePresets-properties.rst
|
||||
|
||||
``hidden``
|
||||
An optional boolean specifying whether or not a preset should be hidden.
|
||||
If a preset is hidden, it cannot be used in the
|
||||
:option:`--preset <cmake --preset>` argument, will not show up in the
|
||||
:manual:`CMake GUI <cmake-gui(1)>`, and does not have to have a valid
|
||||
``generator`` or ``binaryDir``, even from inheritance. ``hidden`` presets are
|
||||
intended to be used as a base for other presets to inherit via the
|
||||
``inherits`` field.
|
||||
|
||||
``inherits``
|
||||
An optional array of strings representing the names of presets to inherit
|
||||
from. This field can also be a string, which is equivalent to an array
|
||||
containing one string.
|
||||
|
||||
The preset will inherit all of the fields from the ``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`` array will be
|
||||
preferred.
|
||||
|
||||
A preset can only inherit from another preset that is defined in the
|
||||
same file or in one of the files it includes (directly or indirectly).
|
||||
Presets in ``CMakePresets.json`` may not inherit from presets in
|
||||
``CMakeUserPresets.json``.
|
||||
|
||||
``condition``
|
||||
An optional `Condition`_ object. This is allowed in preset files specifying
|
||||
version ``3`` or above.
|
||||
|
||||
``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
|
||||
if it does exist. However, it should follow the same conventions as the
|
||||
root-level ``vendor`` field. If vendors use their own per-preset
|
||||
``vendor`` field, they should implement inheritance in a sensible manner
|
||||
when appropriate.
|
||||
|
||||
``displayName``
|
||||
An optional string with a human-friendly name of the preset.
|
||||
|
||||
``description``
|
||||
An optional string with a human-friendly description of the preset.
|
||||
|
||||
.. _`CMakePresets generator`:
|
||||
|
||||
``generator``
|
||||
An optional string representing the :manual:`generator <cmake-generators(7)>`
|
||||
to use for the preset. If ``generator`` is not specified, it must be
|
||||
inherited from the ``inherits`` preset (unless this preset is ``hidden``).
|
||||
In version ``3`` or above, this field may be omitted to fall back to regular
|
||||
generator discovery procedure.
|
||||
|
||||
Note that for :ref:`Visual Studio generators`, unlike in the command line
|
||||
:option:`-G <cmake -G>` argument, you cannot include the platform name
|
||||
in the generator name. Use the ``architecture`` field instead.
|
||||
|
||||
``architecture``, ``toolset``
|
||||
Optional fields representing the platform and toolset, respectively, for
|
||||
:manual:`generators <cmake-generators(7)>` that support them.
|
||||
|
||||
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:
|
||||
|
||||
``value``
|
||||
An optional string representing the value.
|
||||
|
||||
``strategy``
|
||||
An optional string telling CMake how to handle the ``architecture`` or
|
||||
``toolset`` field. Valid values are:
|
||||
|
||||
``"set"``
|
||||
Set the respective value. This will result in an error for generators
|
||||
that do not support the respective field.
|
||||
|
||||
``"external"``
|
||||
Do not set the value, even if the generator supports it. This is
|
||||
useful if, for example, a preset uses the Ninja generator, and an IDE
|
||||
knows how to set up the Visual C++ environment from the
|
||||
``architecture`` and ``toolset`` fields. In that case, CMake will
|
||||
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"``.
|
||||
|
||||
.. _`CMakePresets toolchainFile`:
|
||||
|
||||
``toolchainFile``
|
||||
An optional string representing the path to the toolchain file.
|
||||
This field supports `macro expansion`_. If a relative path is specified,
|
||||
it is calculated relative to the build directory, and if not found,
|
||||
relative to the source directory. This field takes precedence over any
|
||||
:variable:`CMAKE_TOOLCHAIN_FILE` value. It is allowed in preset files
|
||||
specifying version ``3`` or above.
|
||||
|
||||
.. _`CMakePresets graphviz`:
|
||||
|
||||
``graphviz``
|
||||
An optional string representing the path to the graphviz input file,
|
||||
that will contain all the library and executable dependencies
|
||||
in the project. See the documentation for :option:`cmake --graphviz` for
|
||||
more details.
|
||||
|
||||
This field supports `macro expansion`_. If a relative path is specified,
|
||||
it is calculated relative to the current working directory. It is allowed
|
||||
in preset files specifying version ``10`` or above.
|
||||
|
||||
.. _`CMakePresets binaryDir`:
|
||||
|
||||
``binaryDir``
|
||||
An optional string representing the path to the output binary directory.
|
||||
This field supports `macro expansion`_. If a relative path is specified,
|
||||
it is calculated relative to the source directory. If ``binaryDir`` is not
|
||||
specified, it must be inherited from the ``inherits`` preset (unless this
|
||||
preset is ``hidden``). In version ``3`` or above, this field may be
|
||||
omitted.
|
||||
|
||||
.. _`CMakePresets installDir`:
|
||||
|
||||
``installDir``
|
||||
An optional string representing the path to the installation directory,
|
||||
which will be used as the :variable:`CMAKE_INSTALL_PREFIX` variable.
|
||||
This field supports `macro expansion`_. If a relative path is specified,
|
||||
it is calculated relative to the source directory. This is allowed in
|
||||
preset files specifying version ``3`` or above.
|
||||
|
||||
``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``
|
||||
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
|
||||
(which is equivalent to a value of ``"TRUE"`` or ``"FALSE"`` and a type
|
||||
of ``BOOL``), a string representing the value of the variable (which
|
||||
supports `macro expansion`_), or an object with the following fields:
|
||||
|
||||
``type``
|
||||
An optional string representing the type of the variable.
|
||||
|
||||
``value``
|
||||
A required string or boolean representing the value of the variable.
|
||||
A boolean is equivalent to ``"TRUE"`` or ``"FALSE"``. This field
|
||||
supports `macro expansion`_.
|
||||
|
||||
Cache variables are inherited through the ``inherits`` field, and the
|
||||
preset's variables will be the union of its own ``cacheVariables`` and
|
||||
the ``cacheVariables`` from all its parents. If multiple presets in this
|
||||
union define the same variable, the standard rules of ``inherits`` are
|
||||
applied. Setting a variable to ``null`` causes it to not be set, even if
|
||||
a value was inherited from another preset.
|
||||
|
||||
``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
|
||||
a string representing the value of the variable. Each variable is set
|
||||
regardless of whether or not a value was given to it by the process's
|
||||
environment.
|
||||
|
||||
This field supports `macro expansion`_, and environment variables in this map
|
||||
may reference each other, and may be listed in any order, as long as such
|
||||
references do not cause a cycle (for example, if ``ENV_1`` is
|
||||
``$env{ENV_2}``, ``ENV_2`` may not be ``$env{ENV_1}``). ``$penv{NAME}``
|
||||
allows one to prepend or append values to existing environment variables by
|
||||
accessing only values from the parent environment.
|
||||
|
||||
Environment variables are inherited through the ``inherits`` field, and
|
||||
the preset's environment will be the union of its own ``environment`` and
|
||||
the ``environment`` from all its parents. If multiple presets in this
|
||||
union define the same variable, the standard rules of ``inherits`` are
|
||||
applied. Setting a variable to ``null`` causes it to not be set, even if
|
||||
a value was inherited from another preset.
|
||||
|
||||
``warnings``
|
||||
An optional object specifying the warnings to enable. The object may
|
||||
contain the following fields:
|
||||
|
||||
``dev``
|
||||
An optional boolean. Equivalent to passing :option:`-Wdev <cmake -Wdev>`
|
||||
or :option:`-Wno-dev <cmake -Wno-dev>` on the command line. This may not
|
||||
be set to ``false`` if ``errors.dev`` is set to ``true``.
|
||||
|
||||
``deprecated``
|
||||
An optional boolean. Equivalent to passing
|
||||
:option:`-Wdeprecated <cmake -Wdeprecated>` or
|
||||
:option:`-Wno-deprecated <cmake -Wno-deprecated>` on the command line.
|
||||
This may not be set to ``false`` if ``errors.deprecated`` is set to
|
||||
``true``.
|
||||
|
||||
``uninitialized``
|
||||
An optional boolean. Setting this to ``true`` is equivalent to passing
|
||||
:option:`--warn-uninitialized <cmake --warn-uninitialized>` on the command
|
||||
line.
|
||||
|
||||
``unusedCli``
|
||||
An optional boolean. Setting this to ``false`` is equivalent to passing
|
||||
:option:`--no-warn-unused-cli <cmake --no-warn-unused-cli>` on the command
|
||||
line.
|
||||
|
||||
``systemVars``
|
||||
An optional boolean. Setting this to ``true`` is equivalent to passing
|
||||
:option:`--check-system-vars <cmake --check-system-vars>` on the command
|
||||
line.
|
||||
|
||||
``errors``
|
||||
An optional object specifying the errors to enable. The object may
|
||||
contain the following fields:
|
||||
|
||||
``dev``
|
||||
An optional boolean. Equivalent to passing :option:`-Werror=dev <cmake -Werror>`
|
||||
or :option:`-Wno-error=dev <cmake -Werror>` on the command line.
|
||||
This may not be set to ``true`` if ``warnings.dev`` is set to ``false``.
|
||||
|
||||
``deprecated``
|
||||
An optional boolean. Equivalent to passing
|
||||
:option:`-Werror=deprecated <cmake -Werror>` or
|
||||
:option:`-Wno-error=deprecated <cmake -Werror>` on the command line.
|
||||
This may not be set to ``true`` if ``warnings.deprecated`` is set to
|
||||
``false``.
|
||||
|
||||
``debug``
|
||||
An optional object specifying debug options. The object may contain the
|
||||
following fields:
|
||||
|
||||
``output``
|
||||
An optional boolean. Setting this to ``true`` is equivalent to passing
|
||||
:option:`--debug-output <cmake --debug-output>` on the command line.
|
||||
|
||||
``tryCompile``
|
||||
An optional boolean. Setting this to ``true`` is equivalent to passing
|
||||
:option:`--debug-trycompile <cmake --debug-trycompile>` on the command
|
||||
line.
|
||||
|
||||
``find``
|
||||
An optional boolean. Setting this to ``true`` is equivalent to passing
|
||||
:option:`--debug-find <cmake --debug-find>` on the command line.
|
||||
|
||||
.. _`CMakePresets trace`:
|
||||
|
||||
``trace``
|
||||
An optional object specifying trace options. This is allowed in preset
|
||||
files specifying version ``7``. The object may contain the following fields:
|
||||
|
||||
``mode``
|
||||
An optional string that specifies the trace mode. Valid values are:
|
||||
|
||||
``on``
|
||||
Causes a trace of all calls made and from where to be printed.
|
||||
Equivalent to passing :option:`--trace <cmake --trace>` on the command
|
||||
line.
|
||||
|
||||
``off``
|
||||
A trace of all calls will not be printed.
|
||||
|
||||
``expand``
|
||||
Causes a trace with variables expanded of all calls made and from where
|
||||
to be printed. Equivalent to passing :option:`--trace-expand <cmake --trace-expand>`
|
||||
on the command line.
|
||||
|
||||
``format``
|
||||
An optional string that specifies the format output of the trace.
|
||||
Valid values are:
|
||||
|
||||
``human``
|
||||
Prints each trace line in a human-readable format.
|
||||
This is the default format. Equivalent to passing
|
||||
:option:`--trace-format=human <cmake --trace-format>`
|
||||
on the command line.
|
||||
|
||||
``json-v1``
|
||||
Prints each line as a separate JSON document. Equivalent to passing
|
||||
:option:`--trace-format=json-v1 <cmake --trace-format>`
|
||||
on the command line.
|
||||
|
||||
``source``
|
||||
An optional array of strings representing the paths of source files to
|
||||
be traced. This field can also be a string, which is equivalent to an
|
||||
array containing one string. Equivalent to passing
|
||||
:option:`--trace-source <cmake --trace-source>` on the command line.
|
||||
|
||||
``redirect``
|
||||
An optional string specifying a path to a trace output file. Equivalent
|
||||
to passing :option:`--trace-redirect <cmake --trace-redirect>`
|
||||
on the command line.
|
||||
.. _`Build Preset`:
|
||||
|
||||
Build Preset
|
||||
^^^^^^^^^^^^
|
||||
|
||||
.. presets-versionadded:: 2
|
||||
|
||||
Each entry of the ``buildPresets`` 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
|
||||
:option:`cmake --build --preset <cmake--build --preset>` option.
|
||||
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, test,
|
||||
package, or workflow preset.
|
||||
.. include:: presets/buildPresets-properties.rst
|
||||
|
||||
``hidden``
|
||||
An optional boolean specifying whether or not a preset should be hidden.
|
||||
If a preset is hidden, it cannot be used in the
|
||||
:option:`--preset <cmake--build --preset>` argument
|
||||
and does not have to have a valid ``configurePreset``, even from
|
||||
inheritance. ``hidden`` presets are intended to be used as a base for
|
||||
other presets to inherit via the ``inherits`` field.
|
||||
|
||||
``inherits``
|
||||
An optional array of strings representing the names of presets to inherit
|
||||
from. This field can also be a string, which is equivalent to an array
|
||||
containing one string.
|
||||
|
||||
The preset will inherit all of the fields from the
|
||||
``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`` array
|
||||
will be preferred.
|
||||
|
||||
A preset can only inherit from another preset that is defined in the
|
||||
same file or in one of the files it includes (directly or indirectly).
|
||||
Presets in ``CMakePresets.json`` may not inherit from presets in
|
||||
``CMakeUserPresets.json``.
|
||||
|
||||
``condition``
|
||||
An optional `Condition`_ object. This is allowed in preset files specifying
|
||||
version ``3`` or above.
|
||||
|
||||
``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
|
||||
if it does exist. However, it should follow the same conventions as the
|
||||
root-level ``vendor`` field. If vendors use their own per-preset
|
||||
``vendor`` field, they should implement inheritance in a sensible manner
|
||||
when appropriate.
|
||||
|
||||
``displayName``
|
||||
An optional string with a human-friendly name of the preset.
|
||||
|
||||
``description``
|
||||
An optional string with a human-friendly description of the preset.
|
||||
|
||||
.. _`CMakePresets build 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
|
||||
a string representing the value of the variable. Each variable is set
|
||||
regardless of whether or not a value was given to it by the process's
|
||||
environment.
|
||||
|
||||
This field supports `macro expansion`_, and environment variables in this map
|
||||
may reference each other, and may be listed in any order, as long as such
|
||||
references do not cause a cycle (for example, if ``ENV_1`` is
|
||||
``$env{ENV_2}``, ``ENV_2`` may not be ``$env{ENV_1}``). ``$penv{NAME}``
|
||||
allows one to prepend or append values to existing environment variables by
|
||||
accessing only values from the parent environment.
|
||||
|
||||
Environment variables are inherited through the ``inherits`` field, and
|
||||
the preset's environment will be the union of its own ``environment``
|
||||
and the ``environment`` from all its parents. If multiple presets in
|
||||
this union define the same variable, the standard rules of ``inherits``
|
||||
are applied. Setting a variable to ``null`` causes it to not be set,
|
||||
even if a value was inherited from another preset.
|
||||
|
||||
.. note::
|
||||
|
||||
For a CMake project using :module:`ExternalProject` with a configuration
|
||||
preset having environment variables needed in the ExternalProject, use a
|
||||
build preset that inherits that configuration preset or the ExternalProject
|
||||
will not have the environment variables set in the configuration preset.
|
||||
Example: suppose the host defaults to one compiler (say Clang)
|
||||
and the user wishes to use another compiler (say GCC). Set configuration
|
||||
preset environment variables :envvar:`CC` and :envvar:`CXX` and use a build
|
||||
preset that inherits that configuration preset. Otherwise the
|
||||
ExternalProject may use a different (system default) compiler than the
|
||||
top-level CMake project.
|
||||
|
||||
``configurePreset``
|
||||
An optional string specifying the name of a configure preset to
|
||||
associate with this build preset. If ``configurePreset`` is not
|
||||
specified, it must be inherited from the inherits preset (unless this
|
||||
preset is hidden). The build directory is inferred from the configure
|
||||
preset, so the build will take place in the same ``binaryDir`` that the
|
||||
configuration did.
|
||||
|
||||
``inheritConfigureEnvironment``
|
||||
An optional boolean that defaults to true. If true, the environment
|
||||
variables from the associated configure preset are inherited after all
|
||||
inherited build preset environments, but before environment variables
|
||||
explicitly specified in this build preset.
|
||||
|
||||
.. _`CMakePresets build jobs`:
|
||||
|
||||
``jobs``
|
||||
An optional integer. Equivalent to passing
|
||||
:option:`--parallel <cmake--build --parallel>` or ``-j`` on the command line.
|
||||
If the value is ``0``, it is equivalent to passing ``--parallel`` with
|
||||
``<jobs>`` omitted; alternatively, one can define the environment variable
|
||||
:envvar:`CMAKE_BUILD_PARALLEL_LEVEL` as an empty string using the
|
||||
``environment`` field.
|
||||
|
||||
.. versionchanged:: 4.3
|
||||
|
||||
This field does not accept negative integer values, regardless of the
|
||||
version in the preset file.
|
||||
|
||||
``targets``
|
||||
An optional string or array of strings. Equivalent to passing
|
||||
:option:`--target <cmake--build --target>` or ``-t`` on the command line.
|
||||
Vendors may ignore the targets property or hide build presets that
|
||||
explicitly specify targets. This field supports macro expansion.
|
||||
|
||||
``configuration``
|
||||
An optional string. Equivalent to passing
|
||||
:option:`--config <cmake--build --config>` on the command line.
|
||||
|
||||
``cleanFirst``
|
||||
An optional bool. If true, equivalent to passing
|
||||
:option:`--clean-first <cmake--build --clean-first>` on the command line.
|
||||
|
||||
.. _`CMakePresets resolvePackageReferences`:
|
||||
|
||||
``resolvePackageReferences``
|
||||
An optional string that specifies the package resolve mode. This is
|
||||
allowed in preset files specifying version ``4`` or above.
|
||||
|
||||
Package references are used to define dependencies to packages from
|
||||
external package managers. Currently only NuGet in combination with the
|
||||
:ref:`Visual Studio generators` is supported. If there are no targets that
|
||||
define package references, this option does nothing. Valid values are:
|
||||
|
||||
``on``
|
||||
Causes package references to be resolved before attempting a build.
|
||||
|
||||
``off``
|
||||
Package references will not be resolved. Note that this may cause
|
||||
errors in some build environments, such as .NET SDK style projects.
|
||||
|
||||
``only``
|
||||
Only resolve package references, but do not perform a build.
|
||||
|
||||
.. note::
|
||||
|
||||
The command line parameter
|
||||
:option:`--resolve-package-references <cmake--build --resolve-package-references>`
|
||||
will take priority over this setting. If the command line parameter is not
|
||||
provided and this setting is not specified, an environment-specific cache
|
||||
variable will be evaluated to decide, if package restoration should be
|
||||
performed.
|
||||
|
||||
When using the :ref:`Visual Studio generators`, package references are
|
||||
defined using the :prop_tgt:`VS_PACKAGE_REFERENCES` property. Package
|
||||
references are restored using NuGet. It can be disabled by setting the
|
||||
:variable:`CMAKE_VS_NUGET_PACKAGE_RESTORE` variable to ``OFF``. This can
|
||||
also be done from within a configure preset.
|
||||
|
||||
``verbose``
|
||||
An optional bool. If true, equivalent to passing
|
||||
:option:`--verbose <cmake--build --verbose>` on the command line.
|
||||
|
||||
``nativeToolOptions``
|
||||
An optional array of strings. Equivalent to passing options after ``--``
|
||||
on the command line. The array values support macro expansion.
|
||||
.. _`Test Preset`:
|
||||
|
||||
Test Preset
|
||||
^^^^^^^^^^^
|
||||
|
||||
.. presets-versionadded:: 2
|
||||
|
||||
Each entry of the ``testPresets`` 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 :option:`ctest --preset` option.
|
||||
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, build,
|
||||
package, or workflow preset.
|
||||
.. include:: presets/testPresets-properties.rst
|
||||
|
||||
``hidden``
|
||||
An optional boolean specifying whether or not a preset should be hidden.
|
||||
If a preset is hidden, it cannot be used in the
|
||||
:option:`--preset <ctest --preset>` argument
|
||||
and does not have to have a valid ``configurePreset``, even from
|
||||
inheritance. ``hidden`` presets are intended to be used as a base for
|
||||
other presets to inherit via the ``inherits`` field.
|
||||
|
||||
``inherits``
|
||||
An optional array of strings representing the names of presets to inherit
|
||||
from. This field can also be a string, which is equivalent to an array
|
||||
containing one string.
|
||||
|
||||
The preset will inherit all of the fields from the
|
||||
``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`` array
|
||||
will be preferred.
|
||||
|
||||
A preset can only inherit from another preset that is defined in the
|
||||
same file or in one of the files it includes (directly or indirectly).
|
||||
Presets in ``CMakePresets.json`` may not inherit from presets in
|
||||
``CMakeUserPresets.json``.
|
||||
|
||||
``condition``
|
||||
An optional `Condition`_ object. This is allowed in preset files specifying
|
||||
version ``3`` or above.
|
||||
|
||||
``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
|
||||
if it does exist. However, it should follow the same conventions as the
|
||||
root-level ``vendor`` field. If vendors use their own per-preset
|
||||
``vendor`` field, they should implement inheritance in a sensible manner
|
||||
when appropriate.
|
||||
|
||||
``displayName``
|
||||
An optional string with a human-friendly name of the preset.
|
||||
|
||||
``description``
|
||||
An optional string with a human-friendly description of the preset.
|
||||
|
||||
``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
|
||||
a string representing the value of the variable. Each variable is set
|
||||
regardless of whether or not a value was given to it by the process's
|
||||
environment.
|
||||
|
||||
This field supports `macro expansion`_, and environment variables in this map
|
||||
may reference each other, and may be listed in any order, as long as such
|
||||
references do not cause a cycle (for example, if ``ENV_1`` is
|
||||
``$env{ENV_2}``, ``ENV_2`` may not be ``$env{ENV_1}``). ``$penv{NAME}``
|
||||
allows one to prepend or append values to existing environment variables by
|
||||
accessing only values from the parent environment.
|
||||
|
||||
Environment variables are inherited through the ``inherits`` field, and
|
||||
the preset's environment will be the union of its own ``environment``
|
||||
and the ``environment`` from all its parents. If multiple presets in
|
||||
this union define the same variable, the standard rules of ``inherits``
|
||||
are applied. Setting a variable to ``null`` causes it to not be set,
|
||||
even if a value was inherited from another preset.
|
||||
|
||||
``configurePreset``
|
||||
An optional string specifying the name of a configure preset to
|
||||
associate with this test preset. If ``configurePreset`` is not
|
||||
specified, it must be inherited from the inherits preset (unless this
|
||||
preset is hidden). The build directory is inferred from the configure
|
||||
preset, so tests will run in the same ``binaryDir`` that the
|
||||
configuration did and build did.
|
||||
|
||||
``inheritConfigureEnvironment``
|
||||
An optional boolean that defaults to true. If true, the environment
|
||||
variables from the associated configure preset are inherited after all
|
||||
inherited test preset environments, but before environment variables
|
||||
explicitly specified in this test preset.
|
||||
|
||||
``configuration``
|
||||
An optional string. Equivalent to passing
|
||||
:option:`--build-config <ctest --build-config>` on the command line.
|
||||
|
||||
``overwriteConfigurationFile``
|
||||
An optional array of configuration options to overwrite options
|
||||
specified in the CTest configuration file. Equivalent to passing
|
||||
:option:`--overwrite <ctest --overwrite>` for each value in the array.
|
||||
The array values support macro expansion.
|
||||
|
||||
.. _`CMakePresets output`:
|
||||
|
||||
``output``
|
||||
An optional object specifying output options. The object may contain the
|
||||
following fields.
|
||||
|
||||
``shortProgress``
|
||||
An optional bool. If true, equivalent to passing
|
||||
:option:`--progress <ctest --progress>` on the command line.
|
||||
|
||||
``verbosity``
|
||||
An optional string specifying verbosity level. Must be one of the
|
||||
following:
|
||||
|
||||
``default``
|
||||
Equivalent to passing no verbosity flags on the command line.
|
||||
|
||||
``verbose``
|
||||
Equivalent to passing :option:`--verbose <ctest --verbose>` on
|
||||
the command line.
|
||||
|
||||
``extra``
|
||||
Equivalent to passing :option:`--extra-verbose <ctest --extra-verbose>`
|
||||
on the command line.
|
||||
|
||||
``debug``
|
||||
An optional bool. If true, equivalent to passing
|
||||
:option:`--debug <ctest --debug>` on the command line.
|
||||
|
||||
``outputOnFailure``
|
||||
An optional bool. If true, equivalent to passing
|
||||
:option:`--output-on-failure <ctest --output-on-failure>` on the command
|
||||
line.
|
||||
|
||||
``quiet``
|
||||
An optional bool. If true, equivalent to passing
|
||||
:option:`--quiet <ctest --quiet>` on the command line.
|
||||
|
||||
``outputLogFile``
|
||||
An optional string specifying a path to a log file. Equivalent to
|
||||
passing :option:`--output-log <ctest --output-log>` on the command line.
|
||||
This field supports macro expansion.
|
||||
|
||||
.. _`CMakePresets outputJUnitFile`:
|
||||
|
||||
``outputJUnitFile``
|
||||
An optional string specifying a path to a JUnit file. Equivalent to
|
||||
passing :option:`--output-junit <ctest --output-junit>` on the command line.
|
||||
This field supports macro expansion. This is allowed in preset files
|
||||
specifying version ``6`` or above.
|
||||
|
||||
``labelSummary``
|
||||
An optional bool. If false, equivalent to passing
|
||||
:option:`--no-label-summary <ctest --no-label-summary>` on the command
|
||||
line.
|
||||
|
||||
``subprojectSummary``
|
||||
An optional bool. If false, equivalent to passing
|
||||
:option:`--no-subproject-summary <ctest --no-subproject-summary>`
|
||||
on the command line.
|
||||
|
||||
``maxPassedTestOutputSize``
|
||||
An optional integer specifying the maximum output for passed tests in
|
||||
bytes. Equivalent to passing
|
||||
:option:`--test-output-size-passed <ctest --test-output-size-passed>`
|
||||
on the command line.
|
||||
|
||||
``maxFailedTestOutputSize``
|
||||
An optional integer specifying the maximum output for failed tests in
|
||||
bytes. Equivalent to passing
|
||||
:option:`--test-output-size-failed <ctest --test-output-size-failed>`
|
||||
on the command line.
|
||||
|
||||
.. _`CMakePresets testOutputTruncation`:
|
||||
|
||||
``testOutputTruncation``
|
||||
An optional string specifying the test output truncation mode. Equivalent
|
||||
to passing
|
||||
:option:`--test-output-truncation <ctest --test-output-truncation>` on
|
||||
the command line. This is allowed in preset files specifying version
|
||||
``5`` or above.
|
||||
|
||||
``maxTestNameWidth``
|
||||
An optional integer specifying the maximum width of a test name to
|
||||
output. Equivalent to passing :option:`--max-width <ctest --max-width>`
|
||||
on the command line.
|
||||
|
||||
``filter``
|
||||
An optional object specifying how to filter the tests to run. The object
|
||||
may contain the following fields.
|
||||
|
||||
``include``
|
||||
An optional object specifying which tests to include. The object may
|
||||
contain the following fields.
|
||||
|
||||
``name``
|
||||
An optional string specifying a regex for test names. Equivalent to
|
||||
passing :option:`--tests-regex <ctest --tests-regex>` on the command
|
||||
line. This field supports macro expansion. CMake regex syntax is
|
||||
described under :ref:`string(REGEX) <Regex Specification>`.
|
||||
|
||||
``label``
|
||||
An optional string specifying a regex for test labels. Equivalent to
|
||||
passing :option:`--label-regex <ctest --label-regex>` on the command
|
||||
line. This field supports macro expansion.
|
||||
|
||||
``useUnion``
|
||||
An optional bool. Equivalent to passing :option:`--union <ctest --union>`
|
||||
on the command line.
|
||||
|
||||
``index``
|
||||
An optional object specifying tests to include by test index. The
|
||||
object may contain the following fields. Can also be an optional
|
||||
string specifying a file with the command line syntax for
|
||||
:option:`--tests-information <ctest --tests-information>`.
|
||||
If specified as a string, this field supports macro expansion.
|
||||
|
||||
``start``
|
||||
An optional integer specifying a test index to start testing at.
|
||||
|
||||
``end``
|
||||
An optional integer specifying a test index to stop testing at.
|
||||
|
||||
``stride``
|
||||
An optional integer specifying the increment.
|
||||
|
||||
``specificTests``
|
||||
An optional array of integers specifying specific test indices to
|
||||
run.
|
||||
|
||||
``exclude``
|
||||
An optional object specifying which tests to exclude. The object may
|
||||
contain the following fields.
|
||||
|
||||
``name``
|
||||
An optional string specifying a regex for test names. Equivalent to
|
||||
passing :option:`--exclude-regex <ctest --exclude-regex>` on the
|
||||
command line. This field supports macro expansion.
|
||||
|
||||
``label``
|
||||
An optional string specifying a regex for test labels. Equivalent to
|
||||
passing :option:`--label-exclude <ctest --label-exclude>` on the
|
||||
command line. This field supports macro expansion.
|
||||
|
||||
``fixtures``
|
||||
An optional object specifying which fixtures to exclude from adding
|
||||
tests. The object may contain the following fields.
|
||||
|
||||
``any``
|
||||
An optional string specifying a regex for text fixtures to exclude
|
||||
from adding any tests. Equivalent to
|
||||
:option:`--fixture-exclude-any <ctest --fixture-exclude-any>` on
|
||||
the command line. This field supports macro expansion.
|
||||
|
||||
``setup``
|
||||
An optional string specifying a regex for text fixtures to exclude
|
||||
from adding setup tests. Equivalent to
|
||||
:option:`--fixture-exclude-setup <ctest --fixture-exclude-setup>`
|
||||
on the command line. This field supports macro expansion.
|
||||
|
||||
``cleanup``
|
||||
An optional string specifying a regex for text fixtures to exclude
|
||||
from adding cleanup tests. Equivalent to
|
||||
:option:`--fixture-exclude-cleanup <ctest --fixture-exclude-cleanup>`
|
||||
on the command line. This field supports macro expansion.
|
||||
|
||||
``execution``
|
||||
An optional object specifying options for test execution. The object may
|
||||
contain the following fields.
|
||||
|
||||
``stopOnFailure``
|
||||
An optional bool. If true, equivalent to passing
|
||||
:option:`--stop-on-failure <ctest --stop-on-failure>` on the command
|
||||
line.
|
||||
|
||||
``enableFailover``
|
||||
An optional bool. If true, equivalent to passing :option:`-F <ctest -F>`
|
||||
on the command line.
|
||||
|
||||
.. _`CMakePresets test jobs`:
|
||||
|
||||
``jobs``
|
||||
An optional integer. Equivalent to passing
|
||||
:option:`--parallel <ctest --parallel>` on the command line. If the value
|
||||
is ``0``, it is equivalent to unbounded parallelism.
|
||||
|
||||
In preset files specifying version ``11`` or above, this field can also be
|
||||
a string, in which case it must be empty, and is equivalent to passing
|
||||
``--parallel`` with ``<jobs>`` omitted.
|
||||
|
||||
.. versionchanged:: 4.3
|
||||
|
||||
This field does not accept negative integer values, regardless of the
|
||||
version in the preset file.
|
||||
|
||||
``resourceSpecFile``
|
||||
An optional string. Equivalent to passing
|
||||
:option:`--resource-spec-file <ctest --resource-spec-file>` on
|
||||
the command line. This field supports macro expansion.
|
||||
|
||||
``testLoad``
|
||||
An optional integer. Equivalent to passing
|
||||
:option:`--test-load <ctest --test-load>` on the command line.
|
||||
|
||||
``showOnly``
|
||||
An optional string. Equivalent to passing
|
||||
:option:`--show-only <ctest --show-only>` on the
|
||||
command line. The string must be one of the following values:
|
||||
|
||||
``human``
|
||||
|
||||
``json-v1``
|
||||
|
||||
``repeat``
|
||||
An optional object specifying how to repeat tests. Equivalent to
|
||||
passing :option:`--repeat <ctest --repeat>` on the command line.
|
||||
The object must have the following fields.
|
||||
|
||||
``mode``
|
||||
A required string. Must be one of the following values:
|
||||
|
||||
``until-fail``
|
||||
|
||||
``until-pass``
|
||||
|
||||
``after-timeout``
|
||||
|
||||
``count``
|
||||
A required integer.
|
||||
|
||||
``interactiveDebugging``
|
||||
An optional bool. If true, equivalent to passing
|
||||
:option:`--interactive-debug-mode 1 <ctest --interactive-debug-mode>`
|
||||
on the command line. If false, equivalent to passing
|
||||
:option:`--interactive-debug-mode 0 <ctest --interactive-debug-mode>`
|
||||
on the command line.
|
||||
|
||||
``scheduleRandom``
|
||||
An optional bool. If true, equivalent to passing
|
||||
:option:`--schedule-random <ctest --schedule-random>` on the command
|
||||
line.
|
||||
|
||||
``timeout``
|
||||
An optional integer. Equivalent to passing
|
||||
:option:`--timeout <ctest --timeout>` on the command line.
|
||||
|
||||
``noTestsAction``
|
||||
An optional string specifying the behavior if no tests are found. Must
|
||||
be one of the following values:
|
||||
|
||||
``default``
|
||||
Equivalent to not passing any value on the command line.
|
||||
|
||||
``error``
|
||||
Equivalent to passing :option:`--no-tests=error <ctest --no-tests>`
|
||||
on the command line.
|
||||
|
||||
``ignore``
|
||||
Equivalent to passing :option:`--no-tests=ignore <ctest --no-tests>`
|
||||
on the command line.
|
||||
|
||||
.. _`CMakePresets test testPassthroughArguments`:
|
||||
|
||||
``testPassthroughArguments``
|
||||
An optional array of strings. Each element is forwarded as an argument
|
||||
to every test executable, equivalent to passing arguments after
|
||||
:option:`ctest --` on the command line.
|
||||
This is allowed in preset files specifying version ``12`` or above.
|
||||
|
||||
When both preset and command-line passthrough arguments are specified,
|
||||
preset arguments appear first, followed by command-line arguments.
|
||||
.. _`Package Preset`:
|
||||
|
||||
Package Preset
|
||||
^^^^^^^^^^^^^^
|
||||
|
||||
Package presets may be used in schema version ``6`` or above. Each entry of
|
||||
the ``packagePresets`` array is a JSON object that may contain the following
|
||||
fields:
|
||||
.. presets-versionadded:: 6
|
||||
|
||||
``name``
|
||||
A required string representing the machine-friendly name of the preset.
|
||||
This identifier is used in the :option:`cpack --preset` option.
|
||||
There must not be two package presets in the union of ``CMakePresets.json``
|
||||
and ``CMakeUserPresets.json`` in the same directory with the same name.
|
||||
However, a package preset may have the same name as a configure, build,
|
||||
test, or workflow preset.
|
||||
Each entry of the ``packagePresets`` array is a JSON object
|
||||
that may contain the following fields:
|
||||
|
||||
``hidden``
|
||||
An optional boolean specifying whether or not a preset should be hidden.
|
||||
If a preset is hidden, it cannot be used in the
|
||||
:option:`--preset <cpack --preset>` argument
|
||||
and does not have to have a valid ``configurePreset``, even from
|
||||
inheritance. ``hidden`` presets are intended to be used as a base for
|
||||
other presets to inherit via the ``inherits`` field.
|
||||
|
||||
``inherits``
|
||||
An optional array of strings representing the names of presets to inherit
|
||||
from. This field can also be a string, which is equivalent to an array
|
||||
containing one string.
|
||||
|
||||
The preset will inherit all of the fields from the
|
||||
``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`` array
|
||||
will be preferred.
|
||||
|
||||
A preset can only inherit from another preset that is defined in the
|
||||
same file or in one of the files it includes (directly or indirectly).
|
||||
Presets in ``CMakePresets.json`` may not inherit from presets in
|
||||
``CMakeUserPresets.json``.
|
||||
|
||||
``condition``
|
||||
An optional `Condition`_ object.
|
||||
|
||||
``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
|
||||
if it does exist. However, it should follow the same conventions as the
|
||||
root-level ``vendor`` field. If vendors use their own per-preset
|
||||
``vendor`` field, they should implement inheritance in a sensible manner
|
||||
when appropriate.
|
||||
|
||||
``displayName``
|
||||
An optional string with a human-friendly name of the preset.
|
||||
|
||||
``description``
|
||||
An optional string with a human-friendly description of the preset.
|
||||
|
||||
``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
|
||||
a string representing the value of the variable. Each variable is set
|
||||
regardless of whether or not a value was given to it by the process's
|
||||
environment.
|
||||
|
||||
This field supports `macro expansion`_, and environment variables in this map
|
||||
may reference each other, and may be listed in any order, as long as such
|
||||
references do not cause a cycle (for example, if ``ENV_1`` is
|
||||
``$env{ENV_2}``, ``ENV_2`` may not be ``$env{ENV_1}``). ``$penv{NAME}``
|
||||
allows one to prepend or append values to existing environment variables by
|
||||
accessing only values from the parent environment.
|
||||
|
||||
Environment variables are inherited through the ``inherits`` field, and
|
||||
the preset's environment will be the union of its own ``environment``
|
||||
and the ``environment`` from all its parents. If multiple presets in
|
||||
this union define the same variable, the standard rules of ``inherits``
|
||||
are applied. Setting a variable to ``null`` causes it to not be set,
|
||||
even if a value was inherited from another preset.
|
||||
|
||||
``configurePreset``
|
||||
An optional string specifying the name of a configure preset to
|
||||
associate with this package preset. If ``configurePreset`` is not
|
||||
specified, it must be inherited from the inherits preset (unless this
|
||||
preset is hidden). The build directory is inferred from the configure
|
||||
preset, so packaging will run in the same ``binaryDir`` that the
|
||||
configuration did and build did.
|
||||
|
||||
``inheritConfigureEnvironment``
|
||||
An optional boolean that defaults to true. If true, the environment
|
||||
variables from the associated configure preset are inherited after all
|
||||
inherited package preset environments, but before environment variables
|
||||
explicitly specified in this package preset.
|
||||
|
||||
``generators``
|
||||
An optional array of strings representing generators for CPack to use.
|
||||
|
||||
``configurations``
|
||||
An optional array of strings representing build configurations for CPack to
|
||||
package.
|
||||
|
||||
``variables``
|
||||
An optional map of variables to pass to CPack, equivalent to
|
||||
:option:`-D <cpack -D>` arguments. Each key is the name of a variable, and
|
||||
the value is the string to assign to that variable.
|
||||
|
||||
``configFile``
|
||||
An optional string representing the config file for CPack to use.
|
||||
|
||||
``output``
|
||||
An optional object specifying output options. Valid keys are:
|
||||
|
||||
``debug``
|
||||
An optional boolean specifying whether or not to print debug information.
|
||||
A value of ``true`` is equivalent to passing
|
||||
:option:`--debug <cpack --debug>` on the command line.
|
||||
|
||||
``verbose``
|
||||
An optional boolean specifying whether or not to print verbosely. A value
|
||||
of ``true`` is equivalent to passing :option:`--verbose <cpack --verbose>`
|
||||
on the command line.
|
||||
|
||||
``packageName``
|
||||
An optional string representing the package name.
|
||||
|
||||
.. note::
|
||||
|
||||
Due to problems with the implementation, this field does not affect the
|
||||
name of the final package file produced. Other aspects of the package
|
||||
may use the value though, leading to inconsistencies.
|
||||
A future CMake release may address this problem, but until then, it is
|
||||
recommended that this field not be used.
|
||||
|
||||
``packageVersion``
|
||||
An optional string representing the package version.
|
||||
|
||||
.. note::
|
||||
|
||||
Due to problems with the implementation, this field does not affect the
|
||||
name of the final package file produced. Other aspects of the package
|
||||
may use the value though, leading to inconsistencies.
|
||||
A future CMake release may address this problem, but until then, it is
|
||||
recommended that this field not be used.
|
||||
|
||||
``packageDirectory``
|
||||
An optional string representing the directory in which to place the package.
|
||||
|
||||
``vendorName``
|
||||
An optional string representing the vendor name.
|
||||
.. include:: presets/packagePresets-properties.rst
|
||||
|
||||
.. _`Workflow Preset`:
|
||||
|
||||
Workflow Preset
|
||||
^^^^^^^^^^^^^^^
|
||||
|
||||
Workflow presets may be used in schema version ``6`` or above. Each entry of
|
||||
the ``workflowPresets`` array is a JSON object that may contain the following
|
||||
fields:
|
||||
.. presets-versionadded:: 6
|
||||
|
||||
``name``
|
||||
A required string representing the machine-friendly name of the preset.
|
||||
This identifier is used in the
|
||||
:option:`cmake --workflow --preset <cmake--workflow --preset>` option. There
|
||||
must not be two workflow presets in the union of ``CMakePresets.json`` and
|
||||
``CMakeUserPresets.json`` in the same directory with the same name. However,
|
||||
a workflow preset may have the same name as a configure, build, test, or
|
||||
package preset.
|
||||
Each entry of the ``workflowPresets`` array is a JSON object
|
||||
that may contain the following fields:
|
||||
|
||||
``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
|
||||
if it does exist. However, it should follow the same conventions as the
|
||||
root-level ``vendor`` field.
|
||||
|
||||
``displayName``
|
||||
An optional string with a human-friendly name of the preset.
|
||||
|
||||
``description``
|
||||
An optional string with a human-friendly description of the preset.
|
||||
|
||||
``steps``
|
||||
A required array of objects describing the steps of the workflow. The first
|
||||
step must be a configure preset, and all subsequent steps must be
|
||||
non-configure presets whose ``configurePreset`` field matches the starting
|
||||
configure preset. Each object may contain the following fields:
|
||||
|
||||
``type``
|
||||
A required string. The first step must be ``configure``. Subsequent steps
|
||||
must be either ``build``, ``test``, or ``package``.
|
||||
|
||||
``name``
|
||||
A required string representing the name of the configure, build, test, or
|
||||
package preset to run as this workflow step.
|
||||
.. include:: presets/workflowPresets-properties.rst
|
||||
|
||||
Condition
|
||||
^^^^^^^^^
|
||||
|
||||
The ``condition`` field of a preset, allowed in preset files specifying version
|
||||
``3`` or above, is used to determine whether or not the preset is enabled. For
|
||||
example, this can be used to disable a preset on platforms other than Windows.
|
||||
``condition`` may be either a boolean, ``null``, or an object. If it is a
|
||||
boolean, the boolean indicates whether the preset is enabled or disabled. If it
|
||||
is ``null``, the preset is enabled, but the ``null`` condition is not inherited
|
||||
by any presets that may inherit from the preset. Sub-conditions (for example in
|
||||
a ``not``, ``anyOf``, or ``allOf`` condition) may not be ``null``. If it is an
|
||||
object, it has the following fields:
|
||||
.. presets-versionadded:: 3
|
||||
|
||||
The ``condition`` field of a preset is used to determine whether or not the
|
||||
preset is enabled. For example, this can be used to disable a preset on
|
||||
platforms other than Windows. ``condition`` may be either a boolean, ``null``,
|
||||
or an object. If it is a boolean, the boolean indicates whether the preset is
|
||||
enabled or disabled. If it is ``null``, the preset is enabled, but the ``null``
|
||||
condition is not inherited by any presets that may inherit from the preset.
|
||||
Sub-conditions (for example in a ``not``, ``anyOf``, or ``allOf`` condition)
|
||||
may not be ``null``. If it is an object, it has the following fields:
|
||||
|
||||
``type``
|
||||
A required string with one of the following values:
|
||||
@@ -1207,9 +163,7 @@ object, it has the following fields:
|
||||
A required boolean which provides a constant value for the condition's
|
||||
evaluation.
|
||||
|
||||
``"equals"``
|
||||
|
||||
``"notEquals"``
|
||||
``"equals"``, ``"notEquals"``
|
||||
Indicates that the condition compares two strings to see if they are equal
|
||||
(or not equal). The condition object will have the following additional
|
||||
fields:
|
||||
@@ -1220,9 +174,7 @@ object, it has the following fields:
|
||||
``rhs``
|
||||
Second string to compare. This field supports macro expansion.
|
||||
|
||||
``"inList"``
|
||||
|
||||
``"notInList"``
|
||||
``"inList"``, ``"notInList"``
|
||||
Indicates that the condition searches for a string in a list of strings.
|
||||
The condition object will have the following additional fields:
|
||||
|
||||
@@ -1233,9 +185,7 @@ object, it has the following fields:
|
||||
A required array of strings to search. This field supports macro
|
||||
expansion, and uses short-circuit evaluation.
|
||||
|
||||
``"matches"``
|
||||
|
||||
``"notMatches"``
|
||||
``"matches"``, ``"notMatches"``
|
||||
Indicates that the condition searches for a regular expression in a string.
|
||||
The condition object will have the following additional fields:
|
||||
|
||||
@@ -1246,9 +196,7 @@ object, it has the following fields:
|
||||
A required regular expression to search for. This field supports macro
|
||||
expansion.
|
||||
|
||||
``"anyOf"``
|
||||
|
||||
``"allOf"``
|
||||
``"anyOf"``, ``"allOf"``
|
||||
|
||||
Indicates that the condition is an aggregation of zero or more nested
|
||||
conditions. The condition object will have the following additional fields:
|
||||
@@ -1310,44 +258,47 @@ Recognized macros include:
|
||||
.. _`CMakePresets hostSystemName`:
|
||||
|
||||
``${hostSystemName}``
|
||||
.. presets-versionadded:: 3
|
||||
|
||||
The name of the host operating system. Contains the same value as
|
||||
:variable:`CMAKE_HOST_SYSTEM_NAME`. This is allowed in preset files
|
||||
specifying version ``3`` or above.
|
||||
:variable:`CMAKE_HOST_SYSTEM_NAME`.
|
||||
|
||||
.. _`CMakePresets fileDir`:
|
||||
|
||||
``${fileDir}``
|
||||
.. presets-versionadded:: 4
|
||||
|
||||
Path to the directory containing the preset file which defines the preset
|
||||
being used.
|
||||
|
||||
This is allowed in preset files specifying version ``4`` or above.
|
||||
.. presets-versionchanged:: 12
|
||||
|
||||
In preset files specifying version ``12`` or above, this *always* expands to
|
||||
the directory of the current preset file containing the macro, regardless
|
||||
of the preset being used.
|
||||
This macro *always* expands to the directory of the current preset file
|
||||
containing the macro, regardless of the preset being used.
|
||||
|
||||
For example, consider the following scenario.
|
||||
For example, consider the following scenario.
|
||||
|
||||
* ``/path/to/CMakePresets.json`` includes
|
||||
``/path/to/subdir/CMakePresets.json``.
|
||||
* ``/path/to/subdir/CMakePresets.json`` defines preset ``Base``, which
|
||||
sets variable ``MY_DIR`` to ``${fileDir}``.
|
||||
* ``/path/to/CMakePresets.json`` defines preset ``Derived``, and
|
||||
``Derived`` inherits from ``Base``.
|
||||
* ``/path/to/CMakePresets.json`` includes
|
||||
``/path/to/subdir/CMakePresets.json``.
|
||||
* ``/path/to/subdir/CMakePresets.json`` defines preset ``Base``, which
|
||||
sets variable ``MY_DIR`` to ``${fileDir}``.
|
||||
* ``/path/to/CMakePresets.json`` defines preset ``Derived``, and
|
||||
``Derived`` inherits from ``Base``.
|
||||
|
||||
Under preset versions 4-11, ``MY_DIR`` will be set to ``/path/to/`` when
|
||||
using the ``Base`` preset, and ``/path/to/subdir/`` when using the
|
||||
``Derived`` preset.
|
||||
When ``/path/to/subdir/CMakePresets.json`` specifies version ``12`` or
|
||||
above, ``MY_DIR`` will always be set to ``/path/to/subdir/``, regardless of
|
||||
the preset being used.
|
||||
Under preset versions ``4``-``11``, ``MY_DIR`` will be set to ``/path/to/``
|
||||
when using the ``Base`` preset, and ``/path/to/subdir/`` when using the
|
||||
``Derived`` preset.
|
||||
|
||||
.. note::
|
||||
When ``/path/to/subdir/CMakePresets.json`` specifies version ``12`` or
|
||||
above, ``MY_DIR`` will always be set to ``/path/to/subdir/``, regardless of
|
||||
the preset being used.
|
||||
|
||||
Since the ``${fileDir}`` macro in version 12 is expanded in the context of
|
||||
the current preset file, it is the version of the current file, rather than
|
||||
the version of the root file containing the preset being used, which
|
||||
enables this alternative behavior.
|
||||
.. note::
|
||||
|
||||
Since the ``${fileDir}`` macro in version 12 is expanded in the context
|
||||
of the current preset file, it is the version of the current file, rather
|
||||
than the version of the root file containing the preset being used, which
|
||||
enables this alternative behavior.
|
||||
|
||||
``${dollar}``
|
||||
A literal dollar sign (``$``).
|
||||
@@ -1355,6 +306,8 @@ Recognized macros include:
|
||||
.. _`CMakePresets pathListSep`:
|
||||
|
||||
``${pathListSep}``
|
||||
.. presets-versionadded:: 5
|
||||
|
||||
Native character for separating lists of paths, such as ``:`` or ``;``.
|
||||
|
||||
For example, by setting ``PATH`` to
|
||||
@@ -1362,8 +315,6 @@ Recognized macros include:
|
||||
expand to the underlying operating system's character used for
|
||||
concatenation in ``PATH``.
|
||||
|
||||
This is allowed in preset files specifying version ``5`` or above.
|
||||
|
||||
``$env{<variable-name>}``
|
||||
Environment variable with name ``<variable-name>``. The variable name may
|
||||
not be an empty string. If the variable is defined in the ``environment``
|
||||
@@ -1426,10 +377,14 @@ they were added and a summary of the new features and changes is given below.
|
||||
`Build <Build Preset_>`_, and `Test Presets <Test Preset_>`_.
|
||||
* Changes to `Configure Presets <Configure Preset_>`_
|
||||
|
||||
* The `installDir <CMakePresets installDir_>`_ field was added.
|
||||
* The `toolchainFile <CMakePresets toolchainFile_>`_ field was added.
|
||||
* The `binaryDir <CMakePresets binaryDir_>`_ field is now optional.
|
||||
* The `generator <CMakePresets generator_>`_ field is now optional.
|
||||
* The `installDir <CMakePresets.configurePresets.installDir_>`_ field was
|
||||
added.
|
||||
* The `toolchainFile <CMakePresets.configurePresets.toolchainFile_>`_
|
||||
field was added.
|
||||
* The `binaryDir <CMakePresets.configurePresets.binaryDir_>`_ field is
|
||||
now optional.
|
||||
* The `generator <CMakePresets.configurePresets.generator_>`_ field is
|
||||
now optional.
|
||||
|
||||
* Changes to `Macro Expansion`_
|
||||
|
||||
@@ -1444,7 +399,7 @@ they were added and a summary of the new features and changes is given below.
|
||||
* Changes to `Build Presets <Build Preset_>`_
|
||||
|
||||
* The
|
||||
`resolvePackageReferences <CMakePresets resolvePackageReferences_>`_
|
||||
`resolvePackageReferences <CMakePresets.buildPresets.resolvePackageReferences_>`_
|
||||
field was added.
|
||||
|
||||
* Changes to `Macro Expansion`_
|
||||
@@ -1456,8 +411,9 @@ they were added and a summary of the new features and changes is given below.
|
||||
|
||||
* Changes to `Test Presets <Test Preset_>`_
|
||||
|
||||
* The `testOutputTruncation <CMakePresets testOutputTruncation_>`_
|
||||
field was added to the `output <CMakePresets output_>`_ object.
|
||||
* The `testOutputTruncation <CMakePresets.testPresets.output.testOutputTruncation_>`_
|
||||
field was added to the `output <CMakePresets.testPresets.output_>`_
|
||||
object.
|
||||
|
||||
* Changes to `Macro Expansion`_
|
||||
|
||||
@@ -1470,15 +426,16 @@ they were added and a summary of the new features and changes is given below.
|
||||
* `Workflow Presets <Workflow Preset_>`_ were added.
|
||||
* Changes to `Test Presets <Test Preset_>`_
|
||||
|
||||
* The `outputJUnitFile <CMakePresets outputJUnitFile_>`_ field was added
|
||||
to the `output <CMakePresets output_>`_ object.
|
||||
* The `outputJUnitFile <CMakePresets.testPresets.output.outputJUnitFile_>`_
|
||||
field was added to the `output <CMakePresets.testPresets.output_>`_
|
||||
object.
|
||||
|
||||
``7``
|
||||
.. versionadded:: 3.27
|
||||
|
||||
* Changes to `Configure Presets <Configure Preset_>`_
|
||||
|
||||
* The `trace <CMakePresets trace_>`_ field was added.
|
||||
* The `trace <CMakePresets.configurePresets.trace_>`_ field was added.
|
||||
|
||||
* Changes to `Includes`_
|
||||
|
||||
@@ -1487,7 +444,8 @@ they were added and a summary of the new features and changes is given below.
|
||||
``8``
|
||||
.. versionadded:: 3.28
|
||||
|
||||
* The `$schema <CMakePresets schema_>`_ field was added to the root object.
|
||||
* The `$schema <CMakePresets.$schema_>`_ field was added to the root
|
||||
object.
|
||||
|
||||
``9``
|
||||
.. versionadded:: 3.30
|
||||
@@ -1503,16 +461,17 @@ they were added and a summary of the new features and changes is given below.
|
||||
throughout ``CMakePresets.json`` and ``CMakeUserPresets.json``.
|
||||
* Changes to `Configure Presets <Configure Preset_>`_:
|
||||
|
||||
* The `graphviz <CMakePresets graphviz_>`_ field was added.
|
||||
* The `graphviz <CMakePresets.configurePresets.graphviz_>`_ field was
|
||||
added.
|
||||
|
||||
``11``
|
||||
.. versionadded:: 4.3
|
||||
|
||||
* Changes to `Test Presets <Test Preset_>`_
|
||||
|
||||
* The `jobs <CMakePresets test jobs_>`_ field now accepts an empty string
|
||||
representing :option:`--parallel <ctest --parallel>` with ``<jobs>``
|
||||
omitted.
|
||||
* The `jobs <CMakePresets.testPresets.execution.jobs_>`_ field now
|
||||
accepts an empty string representing
|
||||
:ctest-option:`--parallel` with ``<jobs>`` omitted.
|
||||
|
||||
``12``
|
||||
.. versionadded:: 4.4
|
||||
@@ -1526,7 +485,7 @@ they were added and a summary of the new features and changes is given below.
|
||||
|
||||
* Changes to `Test Presets <Test Preset_>`_
|
||||
|
||||
* The `testPassthroughArguments <CMakePresets test testPassthroughArguments_>`_
|
||||
* The `testPassthroughArguments <CMakePresets.testPresets.execution.testPassthroughArguments_>`_
|
||||
field was added to forward arguments to test executables.
|
||||
|
||||
Schema
|
||||
|
||||
@@ -0,0 +1,27 @@
|
||||
.. This file was generated by Utilities/Scripts/regenerate-presets.py
|
||||
from Help/manual/presets/schema.yaml. Do not edit.
|
||||
|
||||
.. _`CMakePresets.configurePresets.architecture.value`:
|
||||
|
||||
``value``
|
||||
An optional string representing the value.
|
||||
|
||||
.. _`CMakePresets.configurePresets.architecture.strategy`:
|
||||
|
||||
``strategy``
|
||||
An optional string telling CMake how to handle the field.
|
||||
Valid values are:
|
||||
|
||||
``"set"``
|
||||
Set the respective value. This will result in an error for generators
|
||||
that do not support the respective field.
|
||||
|
||||
``"external"``
|
||||
Do not set the value, even if the generator supports it. This is
|
||||
useful if, for example, a preset uses the Ninja generator, and an IDE
|
||||
knows how to set up the Visual C++ environment from the architecture
|
||||
and toolset fields. In that case, CMake will 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"``.
|
||||
@@ -0,0 +1,213 @@
|
||||
.. This file was generated by Utilities/Scripts/regenerate-presets.py
|
||||
from Help/manual/presets/schema.yaml. Do not edit.
|
||||
|
||||
.. _`CMakePresets.buildPresets.name`:
|
||||
|
||||
``name``
|
||||
A required string representing the machine-friendly name of the
|
||||
preset. This identifier is used in the
|
||||
:option:`cmake --build --preset <cmake--build --preset>` option.
|
||||
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, test, package, or workflow preset.
|
||||
|
||||
.. _`CMakePresets.buildPresets.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
|
||||
:cmake-build-option:`--preset` argument and does not have to have a
|
||||
valid ``configurePreset``, even from inheritance. ``hidden``
|
||||
presets are intended to be used as a base for other presets to
|
||||
inherit via the ``inherits`` field.
|
||||
|
||||
.. _`CMakePresets.buildPresets.inherits`:
|
||||
|
||||
``inherits``
|
||||
An optional array of strings representing the names of presets from which
|
||||
to inherit. This field can also be a string, which is equivalent to an
|
||||
array containing one string.
|
||||
|
||||
The preset will inherit all of the fields from the ``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`` array will be preferred.
|
||||
|
||||
A preset can only inherit from another preset that is defined in the same
|
||||
file or in one of the files it includes (directly or indirectly). Presets
|
||||
in ``CMakePresets.json`` may not inherit from presets in
|
||||
``CMakeUserPresets.json``.
|
||||
|
||||
.. _`CMakePresets.buildPresets.condition`:
|
||||
|
||||
``condition``
|
||||
.. presets-versionadded:: 3
|
||||
|
||||
An optional `Condition`_ object.
|
||||
|
||||
.. _`CMakePresets.buildPresets.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 if
|
||||
it does exist. However, it should follow the same conventions as the
|
||||
root-level ``vendor`` field. If vendors use their own per-preset
|
||||
``vendor`` field, they should implement inheritance in a sensible manner
|
||||
when appropriate.
|
||||
|
||||
.. _`CMakePresets.buildPresets.displayName`:
|
||||
|
||||
``displayName``
|
||||
An optional string with a human-friendly name of the preset.
|
||||
|
||||
.. _`CMakePresets.buildPresets.description`:
|
||||
|
||||
``description``
|
||||
An optional string with a human-friendly description of the preset.
|
||||
|
||||
.. _`CMakePresets.buildPresets.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 a
|
||||
string representing the value of the variable. Each variable is set
|
||||
regardless of whether or not a value was given to it by the process's
|
||||
environment.
|
||||
|
||||
This field supports `macro expansion`_, and environment variables in this
|
||||
map may reference each other, and may be listed in any order, as long as
|
||||
such references do not cause a cycle (for example, if ``ENV_1`` is
|
||||
``$env{ENV_2}``, ``ENV_2`` may not be ``$env{ENV_1}``). ``$penv{NAME}``
|
||||
allows one to prepend or append values to existing environment variables
|
||||
by accessing only values from the parent environment.
|
||||
|
||||
Environment variables are inherited through the ``inherits`` field, and
|
||||
the preset's environment will be the union of its own ``environment`` and
|
||||
the ``environment`` from all its parents. If multiple presets in this
|
||||
union define the same variable, the standard rules of ``inherits`` are
|
||||
applied. Setting a variable to ``null`` causes it to not be set, even if
|
||||
a value was inherited from another preset.
|
||||
|
||||
.. note::
|
||||
|
||||
For a CMake project using :module:`ExternalProject` with a
|
||||
configuration preset having environment variables needed in the
|
||||
ExternalProject, use a build preset that inherits that
|
||||
configuration preset or the ExternalProject will not have the
|
||||
environment variables set in the configuration preset. Example:
|
||||
suppose the host defaults to one compiler (say Clang) and the user
|
||||
wishes to use another compiler (say GCC). Set configuration preset
|
||||
environment variables :envvar:`CC` and :envvar:`CXX` and use a
|
||||
build preset that inherits that configuration preset. Otherwise the
|
||||
ExternalProject may use a different (system default) compiler than
|
||||
the top-level CMake project.
|
||||
|
||||
|
||||
.. _`CMakePresets.buildPresets.configurePreset`:
|
||||
|
||||
``configurePreset``
|
||||
An optional string specifying the name of a configure preset to
|
||||
associate with this build preset. If ``configurePreset`` is not
|
||||
specified, it must be inherited from the inherits preset (unless
|
||||
this preset is hidden). The build directory is inferred from the
|
||||
configure preset, so the build will take place in the same
|
||||
``binaryDir`` that the configuration did.
|
||||
|
||||
.. _`CMakePresets.buildPresets.inheritConfigureEnvironment`:
|
||||
|
||||
``inheritConfigureEnvironment``
|
||||
An optional boolean that defaults to ``true``. If ``true``, the
|
||||
environment variables from the associated configure preset are
|
||||
inherited after all inherited build preset environments, but before
|
||||
environment variables explicitly specified in this build preset.
|
||||
|
||||
.. _`CMakePresets.buildPresets.jobs`:
|
||||
|
||||
``jobs``
|
||||
An optional integer. Equivalent to passing
|
||||
:cmake-build-option:`--parallel` or ``-j`` on the command line.
|
||||
If the value is ``0``, it is equivalent to passing ``--parallel``
|
||||
with ``<jobs>`` omitted; alternatively, one can define the
|
||||
environment variable :envvar:`CMAKE_BUILD_PARALLEL_LEVEL` as an
|
||||
empty string using the ``environment`` field.
|
||||
|
||||
.. versionchanged:: 4.3
|
||||
|
||||
This field does not accept negative integer values, regardless of
|
||||
the version in the preset file.
|
||||
|
||||
.. _`CMakePresets.buildPresets.targets`:
|
||||
|
||||
``targets``
|
||||
An optional string or array of strings. Equivalent to passing
|
||||
:cmake-build-option:`--target` or ``-t`` on the command line.
|
||||
Vendors may ignore the targets property or hide build presets that
|
||||
explicitly specify targets. This field supports `macro expansion`_.
|
||||
|
||||
.. _`CMakePresets.buildPresets.configuration`:
|
||||
|
||||
``configuration``
|
||||
An optional string. Equivalent to passing
|
||||
:cmake-build-option:`--config` on the command line.
|
||||
|
||||
.. _`CMakePresets.buildPresets.cleanFirst`:
|
||||
|
||||
``cleanFirst``
|
||||
An optional bool. If ``true``, equivalent to passing
|
||||
:cmake-build-option:`--clean-first` on the command line.
|
||||
|
||||
.. _`CMakePresets.buildPresets.resolvePackageReferences`:
|
||||
|
||||
``resolvePackageReferences``
|
||||
.. presets-versionadded:: 4
|
||||
|
||||
An optional string that specifies the package resolve mode.
|
||||
|
||||
Package references are used to define dependencies to packages from
|
||||
external package managers. Currently only NuGet in combination with
|
||||
the :ref:`Visual Studio generators` is supported. If there are no
|
||||
targets that define package references, this option does nothing.
|
||||
Valid values are:
|
||||
|
||||
``on``
|
||||
Causes package references to be resolved before attempting a
|
||||
build.
|
||||
|
||||
``off``
|
||||
Package references will not be resolved. Note that this may cause
|
||||
errors in some build environments, such as .NET SDK style
|
||||
projects.
|
||||
|
||||
``only``
|
||||
Only resolve package references, but do not perform a build.
|
||||
|
||||
.. note::
|
||||
|
||||
The command line parameter
|
||||
:cmake-build-option:`--resolve-package-references`
|
||||
will take priority over this setting. If the command line
|
||||
parameter is not provided and this setting is not specified, an
|
||||
environment-specific cache variable will be evaluated to decide,
|
||||
if package restoration should be performed.
|
||||
|
||||
When using the :ref:`Visual Studio generators`,
|
||||
package references are defined using the
|
||||
:prop_tgt:`VS_PACKAGE_REFERENCES` property. Package references
|
||||
are restored using NuGet. It can be disabled by setting the
|
||||
:variable:`CMAKE_VS_NUGET_PACKAGE_RESTORE` variable to ``OFF``.
|
||||
This can also be done from within a configure preset.
|
||||
|
||||
.. _`CMakePresets.buildPresets.verbose`:
|
||||
|
||||
``verbose``
|
||||
An optional boolean. If ``true``, equivalent to passing
|
||||
:cmake-build-option:`--verbose` on the command line.
|
||||
|
||||
.. _`CMakePresets.buildPresets.nativeToolOptions`:
|
||||
|
||||
``nativeToolOptions``
|
||||
An optional array of strings. Equivalent to passing options after
|
||||
:cmake-build-option:`--` on the command line. The array values
|
||||
support `macro expansion`_.
|
||||
@@ -0,0 +1,7 @@
|
||||
.. This file was generated by Utilities/Scripts/regenerate-presets.py
|
||||
from Help/manual/presets/schema.yaml. Do not edit.
|
||||
|
||||
.. _`CMakePresets.configurePresets.cacheVariables.type`:
|
||||
|
||||
``type``
|
||||
An optional string representing the type of the variable. It should be BOOL, FILEPATH, PATH, STRING, or INTERNAL.
|
||||
@@ -0,0 +1,17 @@
|
||||
.. This file was generated by Utilities/Scripts/regenerate-presets.py
|
||||
from Help/manual/presets/schema.yaml. Do not edit.
|
||||
|
||||
.. _`CMakePresets.cmakeMinimumRequired.major`:
|
||||
|
||||
``major``
|
||||
An optional integer representing the major version.
|
||||
|
||||
.. _`CMakePresets.cmakeMinimumRequired.minor`:
|
||||
|
||||
``minor``
|
||||
An optional integer representing the minor version.
|
||||
|
||||
.. _`CMakePresets.cmakeMinimumRequired.patch`:
|
||||
|
||||
``patch``
|
||||
An optional integer representing the patch version.
|
||||
@@ -0,0 +1,251 @@
|
||||
.. This file was generated by Utilities/Scripts/regenerate-presets.py
|
||||
from Help/manual/presets/schema.yaml. Do not edit.
|
||||
|
||||
.. _`CMakePresets.configurePresets.name`:
|
||||
|
||||
``name``
|
||||
A required string representing the machine-friendly name of the
|
||||
preset. This identifier is used in the :option:`cmake --preset`
|
||||
option. 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, test, package, or workflow preset.
|
||||
|
||||
.. _`CMakePresets.configurePresets.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
|
||||
:cmake-option:`--preset` argument, will not show up in the
|
||||
:manual:`CMake GUI <cmake-gui(1)>`, and does not have to have a
|
||||
valid ``generator`` or ``binaryDir``, even from inheritance.
|
||||
``hidden`` presets are intended to be used as a base for other
|
||||
presets to inherit via the ``inherits`` field.
|
||||
|
||||
.. _`CMakePresets.configurePresets.inherits`:
|
||||
|
||||
``inherits``
|
||||
An optional array of strings representing the names of presets from which
|
||||
to inherit. This field can also be a string, which is equivalent to an
|
||||
array containing one string.
|
||||
|
||||
The preset will inherit all of the fields from the ``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`` array will be preferred.
|
||||
|
||||
A preset can only inherit from another preset that is defined in the same
|
||||
file or in one of the files it includes (directly or indirectly). Presets
|
||||
in ``CMakePresets.json`` may not inherit from presets in
|
||||
``CMakeUserPresets.json``.
|
||||
|
||||
.. _`CMakePresets.configurePresets.condition`:
|
||||
|
||||
``condition``
|
||||
.. presets-versionadded:: 3
|
||||
|
||||
An optional `Condition`_ object.
|
||||
|
||||
.. _`CMakePresets.configurePresets.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 if
|
||||
it does exist. However, it should follow the same conventions as the
|
||||
root-level ``vendor`` field. If vendors use their own per-preset
|
||||
``vendor`` field, they should implement inheritance in a sensible manner
|
||||
when appropriate.
|
||||
|
||||
.. _`CMakePresets.configurePresets.displayName`:
|
||||
|
||||
``displayName``
|
||||
An optional string with a human-friendly name of the preset.
|
||||
|
||||
.. _`CMakePresets.configurePresets.description`:
|
||||
|
||||
``description``
|
||||
An optional string with a human-friendly description of the preset.
|
||||
|
||||
.. _`CMakePresets.configurePresets.generator`:
|
||||
|
||||
``generator``
|
||||
An optional string representing the
|
||||
:manual:`generator <cmake-generators(7)>` to use for the preset.
|
||||
|
||||
.. presets-versionchanged:: 3
|
||||
|
||||
If omitted, CMake will fall back to regular generator discovery
|
||||
procedure. In previous versions, if not specified, this field
|
||||
must be inherited from the ``inherits`` preset (unless this
|
||||
preset is ``hidden``).
|
||||
|
||||
Note that for :ref:`Visual Studio generators`, unlike in the
|
||||
command line :cmake-option:`-G` argument, you cannot include the
|
||||
platform name in the generator name. Use the ``architecture``
|
||||
field instead.
|
||||
|
||||
.. _`CMakePresets.configurePresets.architecture`:
|
||||
|
||||
``architecture``
|
||||
Optional field representing the platform for
|
||||
:manual:`generators <cmake-generators(7)>` that support it.
|
||||
|
||||
See :option:`cmake -A` for possible values.
|
||||
|
||||
``architecture`` may be either a string or an object with the
|
||||
following fields:
|
||||
|
||||
.. include:: presets/architecture-properties.rst
|
||||
|
||||
.. _`CMakePresets.configurePresets.toolset`:
|
||||
|
||||
``toolset``
|
||||
Optional field representing the toolset for
|
||||
:manual:`generators <cmake-generators(7)>` that support it.
|
||||
|
||||
See :option:`cmake -T` for possible values.
|
||||
|
||||
``toolset`` may be either a string or an object with the following
|
||||
fields:
|
||||
|
||||
.. include:: presets/toolset-properties.rst
|
||||
|
||||
.. _`CMakePresets.configurePresets.toolchainFile`:
|
||||
|
||||
``toolchainFile``
|
||||
.. presets-versionadded:: 3
|
||||
|
||||
An optional string representing the path to the toolchain file.
|
||||
This field supports `macro expansion`_. If a relative path is
|
||||
specified, it is calculated relative to the build directory, and if
|
||||
not found, relative to the source directory. This field takes
|
||||
precedence over any :variable:`CMAKE_TOOLCHAIN_FILE` value.
|
||||
|
||||
.. _`CMakePresets.configurePresets.graphviz`:
|
||||
|
||||
``graphviz``
|
||||
.. presets-versionadded:: 10
|
||||
|
||||
An optional string representing the path to the graphviz input
|
||||
file, that will contain all the library and executable dependencies
|
||||
in the project. See the documentation for
|
||||
:option:`cmake --graphviz` for more details.
|
||||
|
||||
This field supports `macro expansion`_. If a relative path is
|
||||
specified, it is calculated relative to the current working
|
||||
directory.
|
||||
|
||||
.. _`CMakePresets.configurePresets.binaryDir`:
|
||||
|
||||
``binaryDir``
|
||||
An optional string representing the path to the output binary
|
||||
directory. This field supports `macro expansion`_. If a relative
|
||||
path is specified, it is calculated relative to the source
|
||||
directory.
|
||||
|
||||
.. presets-versionchanged:: 3
|
||||
|
||||
If omitted, CMake will calculate the path using regular methods.
|
||||
In previous versions, if not specified, this field must be
|
||||
inherited from the ``inherits`` preset (unless this preset is
|
||||
``hidden``).
|
||||
|
||||
.. _`CMakePresets.configurePresets.installDir`:
|
||||
|
||||
``installDir``
|
||||
.. presets-versionadded:: 3
|
||||
|
||||
An optional string representing the path to the installation
|
||||
directory, which will be used as the
|
||||
:variable:`CMAKE_INSTALL_PREFIX` variable. This field supports
|
||||
`macro expansion`_. If a relative path is specified, it is
|
||||
calculated relative to the source directory.
|
||||
|
||||
.. _`CMakePresets.configurePresets.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.
|
||||
|
||||
.. _`CMakePresets.configurePresets.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 (which is equivalent to a value of ``"TRUE"``
|
||||
or ``"FALSE"`` and a type of ``BOOL``), a string representing the
|
||||
value of the variable (which supports `macro expansion`_), or an
|
||||
object with the following fields:
|
||||
|
||||
``type``
|
||||
An optional string representing the type of the variable.
|
||||
|
||||
``value``
|
||||
A required string or boolean representing the value of the
|
||||
variable. A boolean is equivalent to ``"TRUE"`` or ``"FALSE"``.
|
||||
This field supports `macro expansion`_.
|
||||
|
||||
Cache variables are inherited through the ``inherits`` field, and
|
||||
the preset's variables will be the union of its own
|
||||
``cacheVariables`` and the ``cacheVariables`` from all its parents.
|
||||
If multiple presets in this union define the same variable, the
|
||||
standard rules of ``inherits`` are applied. Setting a variable to
|
||||
``null`` causes it to not be set, even if a value was inherited
|
||||
from another preset.
|
||||
|
||||
.. _`CMakePresets.configurePresets.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 a
|
||||
string representing the value of the variable. Each variable is set
|
||||
regardless of whether or not a value was given to it by the process's
|
||||
environment.
|
||||
|
||||
This field supports `macro expansion`_, and environment variables in this
|
||||
map may reference each other, and may be listed in any order, as long as
|
||||
such references do not cause a cycle (for example, if ``ENV_1`` is
|
||||
``$env{ENV_2}``, ``ENV_2`` may not be ``$env{ENV_1}``). ``$penv{NAME}``
|
||||
allows one to prepend or append values to existing environment variables
|
||||
by accessing only values from the parent environment.
|
||||
|
||||
Environment variables are inherited through the ``inherits`` field, and
|
||||
the preset's environment will be the union of its own ``environment`` and
|
||||
the ``environment`` from all its parents. If multiple presets in this
|
||||
union define the same variable, the standard rules of ``inherits`` are
|
||||
applied. Setting a variable to ``null`` causes it to not be set, even if
|
||||
a value was inherited from another preset.
|
||||
|
||||
.. _`CMakePresets.configurePresets.warnings`:
|
||||
|
||||
``warnings``
|
||||
An optional object specifying the warnings to enable.
|
||||
The object may contain the following fields:
|
||||
|
||||
.. include:: presets/warnings-properties.rst
|
||||
|
||||
.. _`CMakePresets.configurePresets.errors`:
|
||||
|
||||
``errors``
|
||||
An optional object specifying the errors to enable.
|
||||
The object may contain the following fields:
|
||||
|
||||
.. include:: presets/errors-properties.rst
|
||||
|
||||
.. _`CMakePresets.configurePresets.debug`:
|
||||
|
||||
``debug``
|
||||
An optional object specifying debug options.
|
||||
The object may contain the following fields:
|
||||
|
||||
.. include:: presets/debug-properties.rst
|
||||
|
||||
.. _`CMakePresets.configurePresets.trace`:
|
||||
|
||||
``trace``
|
||||
.. presets-versionadded:: 7
|
||||
|
||||
An optional object specifying trace options.
|
||||
The object may contain the following fields:
|
||||
|
||||
.. include:: presets/trace-properties.rst
|
||||
@@ -0,0 +1,20 @@
|
||||
.. This file was generated by Utilities/Scripts/regenerate-presets.py
|
||||
from Help/manual/presets/schema.yaml. Do not edit.
|
||||
|
||||
.. _`CMakePresets.configurePresets.debug.output`:
|
||||
|
||||
``output``
|
||||
An optional boolean. Setting this to ``true`` is equivalent to
|
||||
passing :cmake-option:`--debug-output` on the command line.
|
||||
|
||||
.. _`CMakePresets.configurePresets.debug.tryCompile`:
|
||||
|
||||
``tryCompile``
|
||||
An optional boolean. Setting this to ``true`` is equivalent to
|
||||
passing :cmake-option:`--debug-trycompile` on the command line.
|
||||
|
||||
.. _`CMakePresets.configurePresets.debug.find`:
|
||||
|
||||
``find``
|
||||
An optional boolean. Setting this to ``true`` is equivalent to
|
||||
passing :cmake-option:`--debug-find` on the command line.
|
||||
@@ -0,0 +1,22 @@
|
||||
.. This file was generated by Utilities/Scripts/regenerate-presets.py
|
||||
from Help/manual/presets/schema.yaml. Do not edit.
|
||||
|
||||
.. _`CMakePresets.configurePresets.errors.deprecated`:
|
||||
|
||||
``deprecated``
|
||||
An optional boolean. Equivalent to passing
|
||||
:cmake-option:`-Werror=deprecated` or
|
||||
:cmake-option:`-Wno-error=deprecated`
|
||||
on the command line.
|
||||
This may not be set to ``true``
|
||||
if ``warnings.deprecated`` is set to ``false``.
|
||||
|
||||
.. _`CMakePresets.configurePresets.errors.dev`:
|
||||
|
||||
``dev``
|
||||
An optional boolean. Equivalent to passing
|
||||
:cmake-option:`-Werror=dev` or
|
||||
:cmake-option:`-Wno-error=dev`
|
||||
on the command line.
|
||||
This may not be set to ``true``
|
||||
if ``warnings.dev`` is set to ``false``.
|
||||
@@ -0,0 +1,25 @@
|
||||
.. This file was generated by Utilities/Scripts/regenerate-presets.py
|
||||
from Help/manual/presets/schema.yaml. Do not edit.
|
||||
|
||||
.. _`CMakePresets.testPresets.filter.exclude.name`:
|
||||
|
||||
``name``
|
||||
An optional string specifying a regex for test names.
|
||||
Equivalent to passing :ctest-option:`--exclude-regex` on
|
||||
the command line. This field supports `macro expansion`_.
|
||||
|
||||
.. _`CMakePresets.testPresets.filter.exclude.label`:
|
||||
|
||||
``label``
|
||||
An optional string specifying a regex for test labels.
|
||||
Equivalent to passing :ctest-option:`--label-exclude` on
|
||||
the command line. This field supports `macro expansion`_.
|
||||
|
||||
.. _`CMakePresets.testPresets.filter.exclude.fixtures`:
|
||||
|
||||
``fixtures``
|
||||
An optional object specifying which fixtures to exclude
|
||||
from adding tests. The object may contain the following
|
||||
fields:
|
||||
|
||||
.. include:: presets/fixtures-properties.rst
|
||||
@@ -0,0 +1,115 @@
|
||||
.. This file was generated by Utilities/Scripts/regenerate-presets.py
|
||||
from Help/manual/presets/schema.yaml. Do not edit.
|
||||
|
||||
.. _`CMakePresets.testPresets.execution.stopOnFailure`:
|
||||
|
||||
``stopOnFailure``
|
||||
An optional bool. If ``true``, equivalent to passing
|
||||
:ctest-option:`--stop-on-failure` on the command line.
|
||||
|
||||
.. _`CMakePresets.testPresets.execution.enableFailover`:
|
||||
|
||||
``enableFailover``
|
||||
An optional bool. If ``true``, equivalent to passing
|
||||
:ctest-option:`-F` on the command line.
|
||||
|
||||
.. _`CMakePresets.testPresets.execution.jobs`:
|
||||
|
||||
``jobs``
|
||||
An optional integer. Equivalent to passing
|
||||
:ctest-option:`--parallel` on the command line. If the value is
|
||||
``0``, it is equivalent to unbounded parallelism.
|
||||
|
||||
.. presets-versionchanged:: 11
|
||||
|
||||
This field can also be a string, in which case it must be
|
||||
empty, and is equivalent to passing ``--parallel`` with
|
||||
``<jobs>`` omitted.
|
||||
|
||||
.. versionchanged:: 4.3
|
||||
|
||||
This field does not accept negative integer values,
|
||||
regardless of the version in the preset file.
|
||||
|
||||
.. _`CMakePresets.testPresets.execution.resourceSpecFile`:
|
||||
|
||||
``resourceSpecFile``
|
||||
An optional string. Equivalent to passing
|
||||
:ctest-option:`--resource-spec-file` on the command line. This
|
||||
field supports `macro expansion`_.
|
||||
|
||||
.. _`CMakePresets.testPresets.execution.testLoad`:
|
||||
|
||||
``testLoad``
|
||||
An optional integer. Equivalent to passing
|
||||
:ctest-option:`--test-load` on the command line.
|
||||
|
||||
.. _`CMakePresets.testPresets.execution.showOnly`:
|
||||
|
||||
``showOnly``
|
||||
An optional string. Equivalent to passing
|
||||
:ctest-option:`--show-only` on the command line. The string
|
||||
must be one of the following values:
|
||||
|
||||
* ``human``
|
||||
|
||||
* ``json-v1``
|
||||
|
||||
.. _`CMakePresets.testPresets.execution.repeat`:
|
||||
|
||||
``repeat``
|
||||
An optional object specifying how to repeat tests. Equivalent
|
||||
to passing :ctest-option:`--repeat` on the command line.
|
||||
The object must have the following fields:
|
||||
|
||||
.. include:: presets/repeat-properties.rst
|
||||
|
||||
.. _`CMakePresets.testPresets.execution.interactiveDebugging`:
|
||||
|
||||
``interactiveDebugging``
|
||||
An optional bool. If ``true``, equivalent to passing
|
||||
:ctest-option:`--interactive-debug-mode 1` on the command line.
|
||||
If ``false``, equivalent to passing
|
||||
:ctest-option:`--interactive-debug-mode 0` on the command line.
|
||||
|
||||
.. _`CMakePresets.testPresets.execution.scheduleRandom`:
|
||||
|
||||
``scheduleRandom``
|
||||
An optional bool. If ``true``, equivalent to passing
|
||||
:ctest-option:`--schedule-random` on the command line.
|
||||
|
||||
.. _`CMakePresets.testPresets.execution.timeout`:
|
||||
|
||||
``timeout``
|
||||
An optional integer. Equivalent to passing
|
||||
:ctest-option:`--timeout` on the command line.
|
||||
|
||||
.. _`CMakePresets.testPresets.execution.noTestsAction`:
|
||||
|
||||
``noTestsAction``
|
||||
An optional string specifying the behavior if no tests are
|
||||
found. Must be one of the following values:
|
||||
|
||||
``default``
|
||||
Equivalent to not passing any value on the command line.
|
||||
|
||||
``error``
|
||||
Equivalent to passing :ctest-option:`--no-tests=error`
|
||||
on the command line.
|
||||
|
||||
``ignore``
|
||||
Equivalent to passing :ctest-option:`--no-tests=ignore`
|
||||
on the command line.
|
||||
|
||||
.. _`CMakePresets.testPresets.execution.testPassthroughArguments`:
|
||||
|
||||
``testPassthroughArguments``
|
||||
.. presets-versionadded:: 12
|
||||
|
||||
An optional array of strings. Each element is forwarded as an
|
||||
argument to every test executable, equivalent to passing
|
||||
arguments after :option:`ctest --` on the command line.
|
||||
|
||||
When both preset and command-line passthrough arguments are
|
||||
specified, preset arguments appear first, followed by
|
||||
command-line arguments.
|
||||
@@ -0,0 +1,18 @@
|
||||
.. This file was generated by Utilities/Scripts/regenerate-presets.py
|
||||
from Help/manual/presets/schema.yaml. Do not edit.
|
||||
|
||||
.. _`CMakePresets.testPresets.filter.include`:
|
||||
|
||||
``include``
|
||||
An optional object specifying which tests to include.
|
||||
The object may contain the following fields:
|
||||
|
||||
.. include:: presets/include-properties.rst
|
||||
|
||||
.. _`CMakePresets.testPresets.filter.exclude`:
|
||||
|
||||
``exclude``
|
||||
An optional object specifying which tests to exclude.
|
||||
The object may contain the following fields:
|
||||
|
||||
.. include:: presets/exclude-properties.rst
|
||||
@@ -0,0 +1,27 @@
|
||||
.. This file was generated by Utilities/Scripts/regenerate-presets.py
|
||||
from Help/manual/presets/schema.yaml. Do not edit.
|
||||
|
||||
.. _`CMakePresets.testPresets.filter.exclude.fixtures.any`:
|
||||
|
||||
``any``
|
||||
An optional string specifying a regex for text fixtures
|
||||
to exclude from adding any tests. Equivalent to passing
|
||||
:ctest-option:`--fixture-exclude-any` on the command
|
||||
line. This field supports `macro expansion`_.
|
||||
|
||||
.. _`CMakePresets.testPresets.filter.exclude.fixtures.setup`:
|
||||
|
||||
``setup``
|
||||
An optional string specifying a regex for text fixtures
|
||||
to exclude from adding setup tests. Equivalent to
|
||||
passing :ctest-option:`--fixture-exclude-setup` on the
|
||||
command line. This field supports `macro expansion`_.
|
||||
|
||||
.. _`CMakePresets.testPresets.filter.exclude.fixtures.cleanup`:
|
||||
|
||||
``cleanup``
|
||||
An optional string specifying a regex for text fixtures
|
||||
to exclude from adding cleanup tests. Equivalent to
|
||||
passing :ctest-option:`--fixture-exclude-cleanup` on
|
||||
the command line.
|
||||
This field supports `macro expansion`_.
|
||||
@@ -0,0 +1,37 @@
|
||||
.. This file was generated by Utilities/Scripts/regenerate-presets.py
|
||||
from Help/manual/presets/schema.yaml. Do not edit.
|
||||
|
||||
.. _`CMakePresets.testPresets.filter.include.name`:
|
||||
|
||||
``name``
|
||||
An optional string specifying a regex for test names.
|
||||
Equivalent to passing :ctest-option:`--tests-regex` on the
|
||||
command line. This field supports `macro expansion`_.
|
||||
|
||||
CMake regex syntax is described under
|
||||
:ref:`string(REGEX) <Regex Specification>`.
|
||||
|
||||
.. _`CMakePresets.testPresets.filter.include.label`:
|
||||
|
||||
``label``
|
||||
An optional string specifying a regex for test labels.
|
||||
Equivalent to passing :ctest-option:`--label-regex` on the
|
||||
command line. This field supports `macro expansion`_.
|
||||
|
||||
.. _`CMakePresets.testPresets.filter.include.useUnion`:
|
||||
|
||||
``useUnion``
|
||||
An optional bool. Equivalent to passing
|
||||
:ctest-option:`--union` on the command line.
|
||||
|
||||
.. _`CMakePresets.testPresets.filter.include.index`:
|
||||
|
||||
``index``
|
||||
An optional object specifying tests to include by test
|
||||
index. The object may contain the following fields. Can
|
||||
also be an optional string specifying a file with the
|
||||
command line syntax for
|
||||
:ctest-option:`--tests-information`. If specified as a
|
||||
string, this field supports `macro expansion`_.
|
||||
|
||||
.. include:: presets/index-properties.rst
|
||||
@@ -0,0 +1,22 @@
|
||||
.. This file was generated by Utilities/Scripts/regenerate-presets.py
|
||||
from Help/manual/presets/schema.yaml. Do not edit.
|
||||
|
||||
.. _`CMakePresets.testPresets.filter.include.index.start`:
|
||||
|
||||
``start``
|
||||
An optional integer specifying a test index at which to start testing.
|
||||
|
||||
.. _`CMakePresets.testPresets.filter.include.index.end`:
|
||||
|
||||
``end``
|
||||
An optional integer specifying a test index at which to stop testing.
|
||||
|
||||
.. _`CMakePresets.testPresets.filter.include.index.stride`:
|
||||
|
||||
``stride``
|
||||
An optional integer specifying the increment.
|
||||
|
||||
.. _`CMakePresets.testPresets.filter.include.index.specificTests`:
|
||||
|
||||
``specificTests``
|
||||
An optional array of integers specifying specific test indices to run.
|
||||
@@ -0,0 +1,16 @@
|
||||
.. This file was generated by Utilities/Scripts/regenerate-presets.py
|
||||
from Help/manual/presets/schema.yaml. Do not edit.
|
||||
|
||||
.. _`CMakePresets.packagePresets.output.debug`:
|
||||
|
||||
``debug``
|
||||
An optional boolean specifying whether or not to print debug
|
||||
information. A value of ``true`` is equivalent to passing
|
||||
:cpack-option:`--debug` on the command line.
|
||||
|
||||
.. _`CMakePresets.packagePresets.output.verbose`:
|
||||
|
||||
``verbose``
|
||||
An optional boolean specifying whether or not to print
|
||||
verbosely. A value of ``true`` is equivalent to passing
|
||||
:cpack-option:`--verbose` on the command line.
|
||||
@@ -0,0 +1,174 @@
|
||||
.. This file was generated by Utilities/Scripts/regenerate-presets.py
|
||||
from Help/manual/presets/schema.yaml. Do not edit.
|
||||
|
||||
.. _`CMakePresets.packagePresets.name`:
|
||||
|
||||
``name``
|
||||
A required string representing the machine-friendly name of the
|
||||
preset. This identifier is used in the :option:`cpack --preset`
|
||||
option. There must not be two package presets in the union of
|
||||
``CMakePresets.json`` and ``CMakeUserPresets.json`` in the same
|
||||
directory with the same name. However, a package preset may have
|
||||
the same name as a configure, build, test, or workflow preset.
|
||||
|
||||
.. _`CMakePresets.packagePresets.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
|
||||
:cpack-option:`--preset` argument and does not have to have a valid
|
||||
``configurePreset``, even from inheritance. ``hidden`` presets are
|
||||
intended to be used as a base for other presets to inherit via the
|
||||
``inherits`` field.
|
||||
|
||||
.. _`CMakePresets.packagePresets.inherits`:
|
||||
|
||||
``inherits``
|
||||
An optional array of strings representing the names of presets from which
|
||||
to inherit. This field can also be a string, which is equivalent to an
|
||||
array containing one string.
|
||||
|
||||
The preset will inherit all of the fields from the ``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`` array will be preferred.
|
||||
|
||||
A preset can only inherit from another preset that is defined in the same
|
||||
file or in one of the files it includes (directly or indirectly). Presets
|
||||
in ``CMakePresets.json`` may not inherit from presets in
|
||||
``CMakeUserPresets.json``.
|
||||
|
||||
.. _`CMakePresets.packagePresets.condition`:
|
||||
|
||||
``condition``
|
||||
An optional `Condition`_ object.
|
||||
|
||||
.. _`CMakePresets.packagePresets.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 if
|
||||
it does exist. However, it should follow the same conventions as the
|
||||
root-level ``vendor`` field. If vendors use their own per-preset
|
||||
``vendor`` field, they should implement inheritance in a sensible manner
|
||||
when appropriate.
|
||||
|
||||
.. _`CMakePresets.packagePresets.displayName`:
|
||||
|
||||
``displayName``
|
||||
An optional string with a human-friendly name of the preset.
|
||||
|
||||
.. _`CMakePresets.packagePresets.description`:
|
||||
|
||||
``description``
|
||||
An optional string with a human-friendly description of the preset.
|
||||
|
||||
.. _`CMakePresets.packagePresets.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 a
|
||||
string representing the value of the variable. Each variable is set
|
||||
regardless of whether or not a value was given to it by the process's
|
||||
environment.
|
||||
|
||||
This field supports `macro expansion`_, and environment variables in this
|
||||
map may reference each other, and may be listed in any order, as long as
|
||||
such references do not cause a cycle (for example, if ``ENV_1`` is
|
||||
``$env{ENV_2}``, ``ENV_2`` may not be ``$env{ENV_1}``). ``$penv{NAME}``
|
||||
allows one to prepend or append values to existing environment variables
|
||||
by accessing only values from the parent environment.
|
||||
|
||||
Environment variables are inherited through the ``inherits`` field, and
|
||||
the preset's environment will be the union of its own ``environment`` and
|
||||
the ``environment`` from all its parents. If multiple presets in this
|
||||
union define the same variable, the standard rules of ``inherits`` are
|
||||
applied. Setting a variable to ``null`` causes it to not be set, even if
|
||||
a value was inherited from another preset.
|
||||
|
||||
.. _`CMakePresets.packagePresets.configurePreset`:
|
||||
|
||||
``configurePreset``
|
||||
An optional string specifying the name of a configure preset to
|
||||
associate with this package preset. If ``configurePreset`` is not
|
||||
specified, it must be inherited from the inherits preset (unless
|
||||
this preset is hidden). The build directory is inferred from the
|
||||
configure preset, so packaging will run in the same ``binaryDir``
|
||||
that the configuration did and build did.
|
||||
|
||||
.. _`CMakePresets.packagePresets.inheritConfigureEnvironment`:
|
||||
|
||||
``inheritConfigureEnvironment``
|
||||
An optional boolean that defaults to ``true``. If ``true``, the
|
||||
environment variables from the associated configure preset are
|
||||
inherited after all inherited package preset environments, but
|
||||
before environment variables explicitly specified in this package
|
||||
preset.
|
||||
|
||||
.. _`CMakePresets.packagePresets.generators`:
|
||||
|
||||
``generators``
|
||||
An optional array of strings representing generators for CPack to use.
|
||||
|
||||
.. _`CMakePresets.packagePresets.configurations`:
|
||||
|
||||
``configurations``
|
||||
An optional array of strings representing build configurations for CPack to package.
|
||||
|
||||
.. _`CMakePresets.packagePresets.variables`:
|
||||
|
||||
``variables``
|
||||
An optional map of variables to pass to CPack, equivalent to
|
||||
:cpack-option:`-D` arguments. Each key is the name of a variable,
|
||||
and the value is the string to assign to that variable.
|
||||
|
||||
.. _`CMakePresets.packagePresets.configFile`:
|
||||
|
||||
``configFile``
|
||||
An optional string representing the config file for CPack to use.
|
||||
|
||||
.. _`CMakePresets.packagePresets.output`:
|
||||
|
||||
``output``
|
||||
An optional object specifying output options. Valid keys are:
|
||||
|
||||
.. include:: presets/packageOutput-properties.rst
|
||||
|
||||
.. _`CMakePresets.packagePresets.packageName`:
|
||||
|
||||
``packageName``
|
||||
An optional string representing the package name.
|
||||
|
||||
.. note::
|
||||
|
||||
Due to problems with the implementation, this field does not affect
|
||||
the name of the final package file produced. However, other aspects
|
||||
of the package may use the value, leading to inconsistencies. A
|
||||
future CMake release may address this problem, but until then, it
|
||||
is recommended that this field not be used.
|
||||
|
||||
|
||||
.. _`CMakePresets.packagePresets.packageVersion`:
|
||||
|
||||
``packageVersion``
|
||||
An optional string representing the package version.
|
||||
|
||||
.. note::
|
||||
|
||||
Due to problems with the implementation, this field does not affect
|
||||
the name of the final package file produced. However, other aspects
|
||||
of the package may use the value, leading to inconsistencies. A
|
||||
future CMake release may address this problem, but until then, it
|
||||
is recommended that this field not be used.
|
||||
|
||||
|
||||
.. _`CMakePresets.packagePresets.packageDirectory`:
|
||||
|
||||
``packageDirectory``
|
||||
An optional string representing the directory in which to place the package.
|
||||
|
||||
.. _`CMakePresets.packagePresets.vendorName`:
|
||||
|
||||
``vendorName``
|
||||
An optional string representing the vendor name.
|
||||
@@ -0,0 +1,18 @@
|
||||
.. This file was generated by Utilities/Scripts/regenerate-presets.py
|
||||
from Help/manual/presets/schema.yaml. Do not edit.
|
||||
|
||||
.. _`CMakePresets.testPresets.execution.repeat.mode`:
|
||||
|
||||
``mode``
|
||||
A required string. Must be one of the following values:
|
||||
|
||||
* ``until-fail``
|
||||
|
||||
* ``until-pass``
|
||||
|
||||
* ``after-timeout``
|
||||
|
||||
.. _`CMakePresets.testPresets.execution.repeat.count`:
|
||||
|
||||
``count``
|
||||
A required integer.
|
||||
@@ -0,0 +1,78 @@
|
||||
.. This file was generated by Utilities/Scripts/regenerate-presets.py
|
||||
from Help/manual/presets/schema.yaml. Do not edit.
|
||||
|
||||
.. _`CMakePresets.$schema`:
|
||||
|
||||
``$schema``
|
||||
.. presets-versionadded:: 8
|
||||
|
||||
An optional string that provides a URI to the JSON schema that describes the structure of this JSON document. This field is used for validation and autocompletion in editors that support JSON schema. It doesn't affect the behavior of the document itself. If this field is not specified, the JSON document will still be valid, but tools that use JSON schema for validation and autocompletion may not function correctly.
|
||||
|
||||
.. _`CMakePresets.version`:
|
||||
|
||||
``version``
|
||||
A required integer representing the version of the JSON schema. See
|
||||
`Versions`_ for discussion of the supported versions and the
|
||||
corresponding version of CMake in which they were added.
|
||||
|
||||
.. _`CMakePresets.cmakeMinimumRequired`:
|
||||
|
||||
``cmakeMinimumRequired``
|
||||
An optional object representing the minimum version of CMake
|
||||
needed to build this project. This object consists of the following
|
||||
fields:
|
||||
|
||||
.. include:: presets/cmakeMinimumRequired-properties.rst
|
||||
|
||||
.. _`CMakePresets.include`:
|
||||
|
||||
``include``
|
||||
.. presets-versionadded:: 4
|
||||
|
||||
An optional array of strings representing files to include. If the
|
||||
filenames are not absolute, they are considered relative to the current
|
||||
file. See `Includes`_ for discussion of the constraints on included
|
||||
files.
|
||||
|
||||
.. _`CMakePresets.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 if
|
||||
it does exist. However, the keys should be a vendor-specific domain name
|
||||
followed by a ``/``-separated path. For example, the Example IDE 1.0
|
||||
could use ``example.com/ExampleIDE/1.0``. The value of each field can be
|
||||
anything desired by the vendor, though will typically be a map.
|
||||
|
||||
.. _`CMakePresets.configurePresets`:
|
||||
|
||||
``configurePresets``
|
||||
An optional array of `Configure Preset`_ objects.
|
||||
|
||||
.. _`CMakePresets.buildPresets`:
|
||||
|
||||
``buildPresets``
|
||||
.. presets-versionadded:: 2
|
||||
|
||||
An optional array of `Build Preset`_ objects.
|
||||
|
||||
.. _`CMakePresets.testPresets`:
|
||||
|
||||
``testPresets``
|
||||
.. presets-versionadded:: 2
|
||||
|
||||
An optional array of `Test Preset`_ objects.
|
||||
|
||||
.. _`CMakePresets.packagePresets`:
|
||||
|
||||
``packagePresets``
|
||||
.. presets-versionadded:: 6
|
||||
|
||||
An optional array of `Package Preset`_ objects.
|
||||
|
||||
.. _`CMakePresets.workflowPresets`:
|
||||
|
||||
``workflowPresets``
|
||||
.. presets-versionadded:: 6
|
||||
|
||||
An optional array of `Workflow Preset`_ objects.
|
||||
+3758
-2090
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,1990 @@
|
||||
---
|
||||
version: 12
|
||||
types:
|
||||
- id: condition
|
||||
type: variant
|
||||
items:
|
||||
- type: boolean
|
||||
description:
|
||||
A boolean which provides a constant value for the condition's
|
||||
evaluation.
|
||||
# 'const' condition
|
||||
- type: object
|
||||
unevaluatedProperties: false
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
required: true
|
||||
const: const
|
||||
description:
|
||||
A required string specifying the type of the condition.
|
||||
value:
|
||||
type: boolean
|
||||
required: true
|
||||
description:
|
||||
A required boolean which provides a constant value for the
|
||||
condition's evaluation.
|
||||
# 'equals', 'notEquals' condition
|
||||
- type: object
|
||||
unevaluatedProperties: false
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
required: true
|
||||
enum:
|
||||
- equals
|
||||
- notEquals
|
||||
description:
|
||||
A required string specifying the type of the condition.
|
||||
lhs:
|
||||
type: string
|
||||
required: true
|
||||
description:
|
||||
First string to compare. This field supports macro expansion.
|
||||
rhs:
|
||||
type: string
|
||||
required: true
|
||||
description:
|
||||
Second string to compare. This field supports macro expansion.
|
||||
# 'inList', 'notInList' condition
|
||||
- type: object
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
required: true
|
||||
enum:
|
||||
- inList
|
||||
- notInList
|
||||
description:
|
||||
A required string specifying the type of the condition.
|
||||
string:
|
||||
type: string
|
||||
required: true
|
||||
description:
|
||||
A required string to search for. This field supports macro
|
||||
expansion.
|
||||
list:
|
||||
type: array
|
||||
required: true
|
||||
items:
|
||||
type: string
|
||||
description:
|
||||
A required array of strings to search. This field supports macro
|
||||
expansion, and uses short-circuit evaluation.
|
||||
unevaluatedProperties: false
|
||||
# 'matches', 'notMatches' condition
|
||||
- type: object
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
required: true
|
||||
enum:
|
||||
- matches
|
||||
- notMatches
|
||||
description:
|
||||
A required string specifying the type of the condition.
|
||||
string:
|
||||
type: string
|
||||
required: true
|
||||
description:
|
||||
A required string to search. This field supports macro expansion.
|
||||
regex:
|
||||
type: string
|
||||
required: true
|
||||
description:
|
||||
A required regular expression to search for. This field supports
|
||||
macro expansion.
|
||||
unevaluatedProperties: false
|
||||
# 'anyOf', 'allOf' condition
|
||||
- type: object
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
required: true
|
||||
enum:
|
||||
- anyOf
|
||||
- allOf
|
||||
description:
|
||||
A required string specifying the type of the condition.
|
||||
conditions:
|
||||
type: array
|
||||
required: true
|
||||
description:
|
||||
A required array of condition objects. These conditions use
|
||||
short-circuit evaluation.
|
||||
items:
|
||||
type: ref
|
||||
target: condition
|
||||
unevaluatedProperties: false
|
||||
# 'not' condition
|
||||
- type: object
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
required: true
|
||||
const: not
|
||||
description:
|
||||
A required string specifying the type of the condition.
|
||||
condition:
|
||||
type: ref
|
||||
required: true
|
||||
target: condition
|
||||
unevaluatedProperties: false
|
||||
definitions:
|
||||
inherits: &preset-inherits
|
||||
anyOf:
|
||||
- type: string
|
||||
minLength: 1
|
||||
description:
|
||||
An optional string representing the name of the preset from which to
|
||||
inherit.
|
||||
- type: array
|
||||
description:
|
||||
An optional array of strings representing the names of presets from
|
||||
which to inherit. The preset will inherit all of the fields from the
|
||||
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 will be preferred.
|
||||
Presets in CMakePresets.json must not inherit from presets in
|
||||
CMakeUserPresets.json.
|
||||
items:
|
||||
type: string
|
||||
minLength: 1
|
||||
description:
|
||||
An optional string representing the name of the preset from which
|
||||
to inherit.
|
||||
sphinxDescription: |
|
||||
An optional array of strings representing the names of presets from which
|
||||
to inherit. This field can also be a string, which is equivalent to an
|
||||
array containing one string.
|
||||
|
||||
The preset will inherit all of the fields from the ``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`` array will be preferred.
|
||||
|
||||
A preset can only inherit from another preset that is defined in the same
|
||||
file or in one of the files it includes (directly or indirectly). Presets
|
||||
in ``CMakePresets.json`` may not inherit from presets in
|
||||
``CMakeUserPresets.json``.
|
||||
vendor: &preset-vendor
|
||||
type: object
|
||||
minLength: 1
|
||||
description:
|
||||
An optional map containing vendor-specific information. CMake does not
|
||||
interpret the contents of this field except to verify that it is a map if
|
||||
it does exist. However, it should follow the same conventions as the
|
||||
root-level vendor field.
|
||||
sphinxDescription: |
|
||||
An optional map containing vendor-specific information. CMake does not
|
||||
interpret the contents of this field except to verify that it is a map if
|
||||
it does exist. However, it should follow the same conventions as the
|
||||
root-level ``vendor`` field. If vendors use their own per-preset
|
||||
``vendor`` field, they should implement inheritance in a sensible manner
|
||||
when appropriate.
|
||||
properties: {}
|
||||
displayName: &preset-displayName
|
||||
type: string
|
||||
description:
|
||||
An optional string with a human-friendly name of the preset.
|
||||
description: &preset-description
|
||||
type: string
|
||||
description:
|
||||
An optional string with a human-friendly description of the preset.
|
||||
environment: &preset-environment
|
||||
type: object
|
||||
description: &environment-description
|
||||
An optional map of environment variables. The key is the variable name
|
||||
(which must not be an empty string). Each variable is set regardless of
|
||||
whether or not a value was given to it by the process's environment. This
|
||||
field supports macro expansion, and environment variables in this map may
|
||||
reference each other, and may be listed in any order, as long as such
|
||||
references do not cause a cycle (for example,if ENV_1 is $env{ENV_2},
|
||||
ENV_2 may not be $env{ENV_1}.) Environment variables are inherited
|
||||
through the inherits field, and the preset's environment will be the
|
||||
union of its own environment and the environment from all its parents. If
|
||||
multiple presets in this union define the same variable, the standard
|
||||
rules of inherits are applied. Setting a variable to null causes it to
|
||||
not be set, even if a value was inherited from another preset.
|
||||
sphinxDescription: &environment-sphinx-description |
|
||||
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 a
|
||||
string representing the value of the variable. Each variable is set
|
||||
regardless of whether or not a value was given to it by the process's
|
||||
environment.
|
||||
|
||||
This field supports `macro expansion`_, and environment variables in this
|
||||
map may reference each other, and may be listed in any order, as long as
|
||||
such references do not cause a cycle (for example, if ``ENV_1`` is
|
||||
``$env{ENV_2}``, ``ENV_2`` may not be ``$env{ENV_1}``). ``$penv{NAME}``
|
||||
allows one to prepend or append values to existing environment variables
|
||||
by accessing only values from the parent environment.
|
||||
|
||||
Environment variables are inherited through the ``inherits`` field, and
|
||||
the preset's environment will be the union of its own ``environment`` and
|
||||
the ``environment`` from all its parents. If multiple presets in this
|
||||
union define the same variable, the standard rules of ``inherits`` are
|
||||
applied. Setting a variable to ``null`` causes it to not be set, even if
|
||||
a value was inherited from another preset.
|
||||
properties: {}
|
||||
propertyNames:
|
||||
pattern: '^.+$'
|
||||
additionalProperties: &environment-additional-properties
|
||||
anyOf:
|
||||
- type: 'null'
|
||||
description:
|
||||
Setting a variable to null causes it to not be set, even if a value
|
||||
was inherited from another preset.
|
||||
- type: string
|
||||
description:
|
||||
A string representing the value of the variable.
|
||||
architecture-or-toolset: &architecture-or-toolset-properties
|
||||
value:
|
||||
type: string
|
||||
description: An optional string representing the value.
|
||||
strategy:
|
||||
type: string
|
||||
enum:
|
||||
- set
|
||||
- external
|
||||
description: '
|
||||
An optional string telling CMake how to handle the field. Valid values
|
||||
are: "set" Set the respective value. This will result in an error for
|
||||
generators that do not support the respective field. "external" Do not
|
||||
set the value, even if the generator supports it. This is useful if,
|
||||
for example, a preset uses the Ninja generator, and an IDE knows how to
|
||||
set up the Visual C++ environment from the architecture and toolset
|
||||
fields. In that case, CMake will ignore the field, but the IDE can use
|
||||
them to set up the environment before invoking CMake.
|
||||
'
|
||||
sphinxDescription: |
|
||||
An optional string telling CMake how to handle the field.
|
||||
Valid values are:
|
||||
|
||||
``"set"``
|
||||
Set the respective value. This will result in an error for generators
|
||||
that do not support the respective field.
|
||||
|
||||
``"external"``
|
||||
Do not set the value, even if the generator supports it. This is
|
||||
useful if, for example, a preset uses the Ninja generator, and an IDE
|
||||
knows how to set up the Visual C++ environment from the architecture
|
||||
and toolset fields. In that case, CMake will 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"``.
|
||||
condition: &condition
|
||||
since: 3
|
||||
anyOf:
|
||||
- type: ref
|
||||
target: condition
|
||||
- type: 'null'
|
||||
description:
|
||||
Null indicates that the condition always evaluates to true and is not
|
||||
inherited.
|
||||
sphinxDescription: |
|
||||
An optional `Condition`_ object.
|
||||
description:
|
||||
The presets specify the generator and the build directory, and optionally an
|
||||
array of variables and other arguments to pass to CMake.
|
||||
properties:
|
||||
$schema:
|
||||
since: 8
|
||||
type: string
|
||||
format: uri-reference
|
||||
description:
|
||||
An optional string that provides a URI to the JSON schema that describes
|
||||
the structure of this JSON document. This field is used for validation
|
||||
and autocompletion in editors that support JSON schema. It doesn't affect
|
||||
the behavior of the document itself. If this field is not specified, the
|
||||
JSON document will still be valid, but tools that use JSON schema for
|
||||
validation and autocompletion may not function correctly.
|
||||
version:
|
||||
type: integer
|
||||
required: true
|
||||
description:
|
||||
A required integer representing the version of the JSON schema.
|
||||
sphinxDescription: |
|
||||
A required integer representing the version of the JSON schema. See
|
||||
`Versions`_ for discussion of the supported versions and the
|
||||
corresponding version of CMake in which they were added.
|
||||
cmakeMinimumRequired:
|
||||
type: object
|
||||
description:
|
||||
An optional object representing the minimum version of CMake
|
||||
needed to build this project.
|
||||
sphinxDescription: |
|
||||
An optional object representing the minimum version of CMake
|
||||
needed to build this project. This object consists of the following
|
||||
fields:
|
||||
|
||||
.. include:: presets/cmakeMinimumRequired-properties.rst
|
||||
properties:
|
||||
major:
|
||||
type: integer
|
||||
description: An optional integer representing the major version.
|
||||
minor:
|
||||
type: integer
|
||||
description: An optional integer representing the minor version.
|
||||
patch:
|
||||
type: integer
|
||||
description: An optional integer representing the patch version.
|
||||
unevaluatedProperties: false
|
||||
include:
|
||||
since: 4
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
description:
|
||||
An optional array of strings representing files to include. If the
|
||||
filenames are not absolute, they are considered relative to the current
|
||||
file.
|
||||
sphinxDescription: |
|
||||
An optional array of strings representing files to include. If the
|
||||
filenames are not absolute, they are considered relative to the current
|
||||
file. See `Includes`_ for discussion of the constraints on included
|
||||
files.
|
||||
vendor:
|
||||
type: object
|
||||
description:
|
||||
An optional map containing vendor-specific information. CMake does not
|
||||
interpret the contents of this field except to verify that it is a map if
|
||||
it does exist. However, the keys should be a vendor-specific domain name
|
||||
followed by a /-separated path. For example, the Example IDE 1.0 could
|
||||
use example.com/ExampleIDE/1.0. The value of each field can be anything
|
||||
desired by the vendor, though will typically be a map.
|
||||
sphinxDescription: |
|
||||
An optional map containing vendor-specific information. CMake does not
|
||||
interpret the contents of this field except to verify that it is a map if
|
||||
it does exist. However, the keys should be a vendor-specific domain name
|
||||
followed by a ``/``-separated path. For example, the Example IDE 1.0
|
||||
could use ``example.com/ExampleIDE/1.0``. The value of each field can be
|
||||
anything desired by the vendor, though will typically be a map.
|
||||
properties: {}
|
||||
configurePresets:
|
||||
type: array
|
||||
description:
|
||||
An optional array of configure preset objects.
|
||||
sphinxDescription: |
|
||||
An optional array of `Configure Preset`_ objects.
|
||||
items:
|
||||
type: object
|
||||
description:
|
||||
A configure preset object.
|
||||
properties:
|
||||
name:
|
||||
type: string
|
||||
required: true
|
||||
minLength: 1
|
||||
description:
|
||||
A required string representing the machine-friendly name of the
|
||||
preset. This identifier is used in the cmake --preset option.
|
||||
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, test, package, or workflow preset.
|
||||
sphinxDescription: |
|
||||
A required string representing the machine-friendly name of the
|
||||
preset. This identifier is used in the :option:`cmake --preset`
|
||||
option. 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, test, package, or workflow preset.
|
||||
hidden:
|
||||
type: boolean
|
||||
description:
|
||||
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, will not show up in the CMake GUI, and does not have to
|
||||
have a valid generator or binaryDir, even from inheritance. Hidden
|
||||
presets are intended to be used as a base for other presets to
|
||||
inherit via the inherits field.
|
||||
sphinxDescription: |
|
||||
An optional boolean specifying whether or not a preset should be
|
||||
hidden. If a preset is hidden, it cannot be used in the
|
||||
:cmake-option:`--preset` argument, will not show up in the
|
||||
:manual:`CMake GUI <cmake-gui(1)>`, and does not have to have a
|
||||
valid ``generator`` or ``binaryDir``, even from inheritance.
|
||||
``hidden`` presets are intended to be used as a base for other
|
||||
presets to inherit via the ``inherits`` field.
|
||||
inherits: *preset-inherits
|
||||
condition: *condition
|
||||
vendor: *preset-vendor
|
||||
displayName: *preset-displayName
|
||||
description: *preset-description
|
||||
generator:
|
||||
revisions:
|
||||
- until: 3
|
||||
type: string
|
||||
description:
|
||||
An optional string representing the generator to use for the
|
||||
preset. If generator is not specified, it must be inherited
|
||||
from the inherits preset (unless this preset is hidden). Note
|
||||
that for Visual Studio generators, unlike in the command line
|
||||
-G argument, you cannot include the platform name in the
|
||||
generator name. Use the architecture field instead.
|
||||
- since: 3
|
||||
type: string
|
||||
description:
|
||||
An optional string representing the generator to use for the
|
||||
preset. If generator is not specified, the normal generator
|
||||
discovery procedure is used. Note that for Visual Studio
|
||||
generators, unlike in the command line -G argument, you cannot
|
||||
include the platform name in the generator name. Use the
|
||||
architecture field instead.
|
||||
sphinxDescription: |
|
||||
An optional string representing the
|
||||
:manual:`generator <cmake-generators(7)>` to use for the preset.
|
||||
|
||||
.. presets-versionchanged:: 3
|
||||
|
||||
If omitted, CMake will fall back to regular generator discovery
|
||||
procedure. In previous versions, if not specified, this field
|
||||
must be inherited from the ``inherits`` preset (unless this
|
||||
preset is ``hidden``).
|
||||
|
||||
Note that for :ref:`Visual Studio generators`, unlike in the
|
||||
command line :cmake-option:`-G` argument, you cannot include the
|
||||
platform name in the generator name. Use the ``architecture``
|
||||
field instead.
|
||||
architecture:
|
||||
anyOf:
|
||||
- type: string
|
||||
description: &architectureDescription
|
||||
An optional string representing the platform for generators
|
||||
that support it.
|
||||
- type: object
|
||||
description: *architectureDescription
|
||||
properties: *architecture-or-toolset-properties
|
||||
unevaluatedProperties: false
|
||||
sphinxDescription: |
|
||||
Optional field representing the platform for
|
||||
:manual:`generators <cmake-generators(7)>` that support it.
|
||||
|
||||
See :option:`cmake -A` for possible values.
|
||||
|
||||
``architecture`` may be either a string or an object with the
|
||||
following fields:
|
||||
|
||||
.. include:: presets/architecture-properties.rst
|
||||
toolset:
|
||||
anyOf:
|
||||
- type: string
|
||||
description: &toolsetDescription
|
||||
An optional string representing the toolset for generators that
|
||||
support it.
|
||||
- type: object
|
||||
description: *toolsetDescription
|
||||
properties: *architecture-or-toolset-properties
|
||||
unevaluatedProperties: false
|
||||
sphinxDescription: |
|
||||
Optional field representing the toolset for
|
||||
:manual:`generators <cmake-generators(7)>` that support it.
|
||||
|
||||
See :option:`cmake -T` for possible values.
|
||||
|
||||
``toolset`` may be either a string or an object with the following
|
||||
fields:
|
||||
|
||||
.. include:: presets/toolset-properties.rst
|
||||
toolchainFile:
|
||||
since: 3
|
||||
type: string
|
||||
description:
|
||||
An optional string representing the path to the toolchain file.
|
||||
This field supports macro expansion. If a relative path is
|
||||
specified, it is calculated relative to the build directory, and if
|
||||
not found, relative to the source directory.
|
||||
sphinxDescription: |
|
||||
An optional string representing the path to the toolchain file.
|
||||
This field supports `macro expansion`_. If a relative path is
|
||||
specified, it is calculated relative to the build directory, and if
|
||||
not found, relative to the source directory. This field takes
|
||||
precedence over any :variable:`CMAKE_TOOLCHAIN_FILE` value.
|
||||
graphviz:
|
||||
since: 10
|
||||
type: string
|
||||
description:
|
||||
An optional string specifying the path to the graphviz dot file.
|
||||
sphinxDescription: |
|
||||
An optional string representing the path to the graphviz input
|
||||
file, that will contain all the library and executable dependencies
|
||||
in the project. See the documentation for
|
||||
:option:`cmake --graphviz` for more details.
|
||||
|
||||
This field supports `macro expansion`_. If a relative path is
|
||||
specified, it is calculated relative to the current working
|
||||
directory.
|
||||
binaryDir:
|
||||
revisions:
|
||||
- until: 3
|
||||
type: string
|
||||
description:
|
||||
An optional string representing the path to the output binary
|
||||
directory. This field supports macro expansion. If a relative
|
||||
path is specified, it is calculated relative to the source
|
||||
directory. If binaryDir is not specified, it must be inherited
|
||||
from the inherits preset (unless this preset is hidden).
|
||||
- since: 3
|
||||
type: string
|
||||
description:
|
||||
An optional string representing the path to the output binary
|
||||
directory. This field supports macro expansion. If a relative
|
||||
path is specified, it is calculated relative to the source
|
||||
directory. If binaryDir is not specified, the path is
|
||||
calculated using regular methods.
|
||||
sphinxDescription: |
|
||||
An optional string representing the path to the output binary
|
||||
directory. This field supports `macro expansion`_. If a relative
|
||||
path is specified, it is calculated relative to the source
|
||||
directory.
|
||||
|
||||
.. presets-versionchanged:: 3
|
||||
|
||||
If omitted, CMake will calculate the path using regular methods.
|
||||
In previous versions, if not specified, this field must be
|
||||
inherited from the ``inherits`` preset (unless this preset is
|
||||
``hidden``).
|
||||
installDir:
|
||||
since: 3
|
||||
type: string
|
||||
description:
|
||||
An optional string representing the path to the installation
|
||||
directory, which will be used as the CMAKE_INSTALL_PREFIX variable.
|
||||
This field supports macro expansion. If a relative path is
|
||||
specified, it is calculated relative to the source directory.
|
||||
sphinxDescription: |
|
||||
An optional string representing the path to the installation
|
||||
directory, which will be used as the
|
||||
:variable:`CMAKE_INSTALL_PREFIX` variable. This field supports
|
||||
`macro expansion`_. If a relative path is specified, it is
|
||||
calculated relative to the source directory.
|
||||
cmakeExecutable:
|
||||
type: string
|
||||
description:
|
||||
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:
|
||||
type: object
|
||||
description:
|
||||
An optional map of cache variables. The key is the variable name
|
||||
(which must not be an empty string). Cache variables are inherited
|
||||
through the inherits field, and the preset's variables will be the
|
||||
union of its own cacheVariables and the cacheVariables from all its
|
||||
parents. If multiple presets in this union define the same
|
||||
variable, the standard rules of inherits are applied.
|
||||
sphinxDescription: |
|
||||
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 (which is equivalent to a value of ``"TRUE"``
|
||||
or ``"FALSE"`` and a type of ``BOOL``), a string representing the
|
||||
value of the variable (which supports `macro expansion`_), or an
|
||||
object with the following fields:
|
||||
|
||||
``type``
|
||||
An optional string representing the type of the variable.
|
||||
|
||||
``value``
|
||||
A required string or boolean representing the value of the
|
||||
variable. A boolean is equivalent to ``"TRUE"`` or ``"FALSE"``.
|
||||
This field supports `macro expansion`_.
|
||||
|
||||
Cache variables are inherited through the ``inherits`` field, and
|
||||
the preset's variables will be the union of its own
|
||||
``cacheVariables`` and the ``cacheVariables`` from all its parents.
|
||||
If multiple presets in this union define the same variable, the
|
||||
standard rules of ``inherits`` are applied. Setting a variable to
|
||||
``null`` causes it to not be set, even if a value was inherited
|
||||
from another preset.
|
||||
properties: {}
|
||||
propertyNames:
|
||||
pattern: '^.+$'
|
||||
additionalProperties:
|
||||
anyOf:
|
||||
- type: 'null'
|
||||
description:
|
||||
Setting a variable to null causes it to not be set, even if a
|
||||
value was inherited from another preset.
|
||||
- type: boolean
|
||||
description:
|
||||
A boolean representing the value of the variable. Equivalent
|
||||
to "TRUE" or "FALSE"
|
||||
- type: string
|
||||
description:
|
||||
A string representing the value of the variable (which
|
||||
supports macro expansion).
|
||||
- type: object
|
||||
description:
|
||||
An optional object representing the cache variables for
|
||||
generators that support it.
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
enum:
|
||||
- BOOL
|
||||
- FILEPATH
|
||||
- PATH
|
||||
- STRING
|
||||
- INTERNAL
|
||||
description:
|
||||
An optional string representing the type of the variable.
|
||||
It should be BOOL, FILEPATH, PATH, STRING, or INTERNAL.
|
||||
value:
|
||||
required: true
|
||||
anyOf:
|
||||
- type: boolean
|
||||
description:
|
||||
A boolean representing the value of the variable.
|
||||
Equivalent to "TRUE" or "FALSE".
|
||||
- type: string
|
||||
description:
|
||||
A string representing the value of the variable
|
||||
(which supports macro expansion).
|
||||
unevaluatedProperties: false
|
||||
environment: *preset-environment
|
||||
warnings:
|
||||
type: object
|
||||
description:
|
||||
An optional object specifying the warnings to enable.
|
||||
sphinxDescription: |
|
||||
An optional object specifying the warnings to enable.
|
||||
The object may contain the following fields:
|
||||
|
||||
.. include:: presets/warnings-properties.rst
|
||||
properties:
|
||||
# These should be in lexicographical order, except for systemVars.
|
||||
deprecated:
|
||||
type: boolean
|
||||
description:
|
||||
An optional boolean. Equivalent to passing -Wdeprecated or
|
||||
-Wno-deprecated on the command line. This may not be set
|
||||
to false if errors.deprecated is set to true.
|
||||
sphinxDescription: |
|
||||
An optional boolean. Equivalent to passing
|
||||
:cmake-option:`-Wdeprecated` or
|
||||
:cmake-option:`-Wno-deprecated`
|
||||
on the command line.
|
||||
This may not be set to ``false``
|
||||
if ``errors.deprecated`` is set to ``true``.
|
||||
dev:
|
||||
type: boolean
|
||||
description:
|
||||
An optional boolean. Equivalent to passing -Wdev or
|
||||
-Wno-dev on the command line. This may not be set
|
||||
to false if errors.dev is set to true.
|
||||
sphinxDescription: |
|
||||
An optional boolean. Equivalent to passing
|
||||
:cmake-option:`-Wdev` or
|
||||
:cmake-option:`-Wno-dev`
|
||||
on the command line.
|
||||
This may not be set to ``false``
|
||||
if ``errors.dev`` is set to ``true``.
|
||||
uninitialized:
|
||||
type: boolean
|
||||
description:
|
||||
An optional boolean. Setting this to true is equivalent to
|
||||
passing --warn-uninitialized on the command line.
|
||||
sphinxDescription: |
|
||||
An optional boolean. Setting this to ``true`` is equivalent to
|
||||
passing :cmake-option:`--warn-uninitialized` on the command
|
||||
line.
|
||||
unusedCli:
|
||||
type: boolean
|
||||
description:
|
||||
An optional boolean. Setting this to false is equivalent to
|
||||
passing --no-warn-unused-cli on the command line.
|
||||
sphinxDescription: |
|
||||
An optional boolean. Setting this to ``false`` is equivalent to
|
||||
passing :cmake-option:`--no-warn-unused-cli` on the command
|
||||
line.
|
||||
# systemVars should be last.
|
||||
systemVars:
|
||||
type: boolean
|
||||
description:
|
||||
An optional boolean. Setting this to true is equivalent to
|
||||
passing --check-system-vars on the command line.
|
||||
sphinxDescription: |
|
||||
An optional boolean. Setting this to ``true`` is equivalent to
|
||||
passing :cmake-option:`--check-system-vars` on the command
|
||||
line.
|
||||
unevaluatedProperties: false
|
||||
errors:
|
||||
type: object
|
||||
description:
|
||||
An optional object specifying the errors to enable.
|
||||
sphinxDescription: |
|
||||
An optional object specifying the errors to enable.
|
||||
The object may contain the following fields:
|
||||
|
||||
.. include:: presets/errors-properties.rst
|
||||
properties:
|
||||
# These should be in lexicographical order.
|
||||
deprecated:
|
||||
type: boolean
|
||||
description:
|
||||
An optional boolean. Equivalent to passing
|
||||
-Werror=deprecated or -Wno-error=deprecated
|
||||
on the command line. This may not be set
|
||||
to true if warnings.deprecated is set to false.
|
||||
sphinxDescription: |
|
||||
An optional boolean. Equivalent to passing
|
||||
:cmake-option:`-Werror=deprecated` or
|
||||
:cmake-option:`-Wno-error=deprecated`
|
||||
on the command line.
|
||||
This may not be set to ``true``
|
||||
if ``warnings.deprecated`` is set to ``false``.
|
||||
dev:
|
||||
type: boolean
|
||||
description:
|
||||
An optional boolean. Equivalent to passing
|
||||
-Werror=dev or -Wno-error=dev
|
||||
on the command line. This may not be set
|
||||
to true if warnings.dev is set to false.
|
||||
sphinxDescription: |
|
||||
An optional boolean. Equivalent to passing
|
||||
:cmake-option:`-Werror=dev` or
|
||||
:cmake-option:`-Wno-error=dev`
|
||||
on the command line.
|
||||
This may not be set to ``true``
|
||||
if ``warnings.dev`` is set to ``false``.
|
||||
unevaluatedProperties: false
|
||||
debug:
|
||||
type: object
|
||||
description:
|
||||
An optional object specifying debug options.
|
||||
sphinxDescription: |
|
||||
An optional object specifying debug options.
|
||||
The object may contain the following fields:
|
||||
|
||||
.. include:: presets/debug-properties.rst
|
||||
properties:
|
||||
output:
|
||||
type: boolean
|
||||
description:
|
||||
An optional boolean. Setting this to true is equivalent to
|
||||
passing --debug-output on the command line.
|
||||
sphinxDescription: |
|
||||
An optional boolean. Setting this to ``true`` is equivalent to
|
||||
passing :cmake-option:`--debug-output` on the command line.
|
||||
tryCompile:
|
||||
type: boolean
|
||||
description:
|
||||
An optional boolean. Setting this to true is equivalent to
|
||||
passing --debug-trycompile on the command line.
|
||||
sphinxDescription: |
|
||||
An optional boolean. Setting this to ``true`` is equivalent to
|
||||
passing :cmake-option:`--debug-trycompile` on the command line.
|
||||
find:
|
||||
type: boolean
|
||||
description:
|
||||
An optional boolean. Setting this to true is equivalent to
|
||||
passing --debug-find on the command line.
|
||||
sphinxDescription: |
|
||||
An optional boolean. Setting this to ``true`` is equivalent to
|
||||
passing :cmake-option:`--debug-find` on the command line.
|
||||
unevaluatedProperties: false
|
||||
trace:
|
||||
since: 7
|
||||
type: object
|
||||
description:
|
||||
An optional object specifying trace options.
|
||||
sphinxDescription: |
|
||||
An optional object specifying trace options.
|
||||
The object may contain the following fields:
|
||||
|
||||
.. include:: presets/trace-properties.rst
|
||||
properties:
|
||||
mode:
|
||||
type: string
|
||||
enum:
|
||||
- 'on'
|
||||
- 'off'
|
||||
- 'expand'
|
||||
description:
|
||||
An optional string that specifies the trace mode.
|
||||
sphinxDescription: |
|
||||
An optional string that specifies the trace mode.
|
||||
Valid values are:
|
||||
|
||||
``on``
|
||||
Causes a trace of all calls made and from where to be
|
||||
printed. Equivalent to passing :cmake-option:`--trace`
|
||||
on the command line.
|
||||
|
||||
``off``
|
||||
A trace of all calls will not be printed.
|
||||
|
||||
``expand``
|
||||
Causes a trace with variables expanded of all calls made
|
||||
and from where to be printed. Equivalent to passing
|
||||
:cmake-option:`--trace-expand` on the command line.
|
||||
format:
|
||||
type: string
|
||||
enum:
|
||||
- human
|
||||
- json-v1
|
||||
description:
|
||||
An optional string that specifies the trace output format.
|
||||
sphinxDescription: |
|
||||
An optional string that specifies the format output of the
|
||||
trace. Valid values are:
|
||||
|
||||
``human``
|
||||
Prints each trace line in a human-readable format.
|
||||
This is the default format. Equivalent to passing
|
||||
:cmake-option:`--trace-format=human`
|
||||
on the command line.
|
||||
|
||||
``json-v1``
|
||||
Prints each line as a separate JSON document. Equivalent
|
||||
to passing :cmake-option:`--trace-format=json-v1`
|
||||
on the command line.
|
||||
source:
|
||||
anyOf:
|
||||
- type: string
|
||||
minLength: 1
|
||||
description:
|
||||
An optional string representing the path to one source file
|
||||
to be traced.
|
||||
- type: array
|
||||
description:
|
||||
An optional array of strings representing the paths to source
|
||||
files to be traced.
|
||||
items:
|
||||
type: string
|
||||
minLength: 1
|
||||
description:
|
||||
A string representing the path to one source file to be
|
||||
traced.
|
||||
sphinxDescription: |
|
||||
An optional array of strings representing the paths of source
|
||||
files to be traced. This field can also be a string, which is
|
||||
equivalent to an array containing one string. Equivalent to
|
||||
passing :cmake-option:`--trace-source` on the command line.
|
||||
redirect:
|
||||
type: string
|
||||
description:
|
||||
An optional string specifying a path to a trace output file.
|
||||
sphinxDescription: |
|
||||
An optional string specifying a path to a trace output file.
|
||||
Equivalent to passing :cmake-option:`--trace-redirect` on the
|
||||
command line.
|
||||
unevaluatedProperties: false
|
||||
unevaluatedProperties: false
|
||||
buildPresets:
|
||||
since: 2
|
||||
type: array
|
||||
description:
|
||||
An optional array of build preset objects.
|
||||
sphinxDescription: |
|
||||
An optional array of `Build Preset`_ objects.
|
||||
items:
|
||||
type: object
|
||||
description:
|
||||
A build preset object.
|
||||
properties:
|
||||
name:
|
||||
type: string
|
||||
required: true
|
||||
minLength: 1
|
||||
description:
|
||||
A required string representing the machine-friendly name of the
|
||||
preset. This identifier is used in the cmake --build --preset
|
||||
option. 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, test, package, or workflow preset.
|
||||
sphinxDescription: |
|
||||
A required string representing the machine-friendly name of the
|
||||
preset. This identifier is used in the
|
||||
:option:`cmake --build --preset <cmake--build --preset>` option.
|
||||
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, test, package, or workflow preset.
|
||||
hidden:
|
||||
type: boolean
|
||||
description:
|
||||
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 and does not have to have a valid configurePreset, even
|
||||
from inheritance. hidden presets are intended to be used as a base
|
||||
for other presets to inherit via the inherits field.
|
||||
sphinxDescription: |
|
||||
An optional boolean specifying whether or not a preset should be
|
||||
hidden. If a preset is hidden, it cannot be used in the
|
||||
:cmake-build-option:`--preset` argument and does not have to have a
|
||||
valid ``configurePreset``, even from inheritance. ``hidden``
|
||||
presets are intended to be used as a base for other presets to
|
||||
inherit via the ``inherits`` field.
|
||||
inherits: *preset-inherits
|
||||
condition: *condition
|
||||
vendor: *preset-vendor
|
||||
displayName: *preset-displayName
|
||||
description: *preset-description
|
||||
environment:
|
||||
type: object
|
||||
description: *environment-description
|
||||
sphinxDescription: *environment-sphinx-description
|
||||
sphinxNote: |
|
||||
For a CMake project using :module:`ExternalProject` with a
|
||||
configuration preset having environment variables needed in the
|
||||
ExternalProject, use a build preset that inherits that
|
||||
configuration preset or the ExternalProject will not have the
|
||||
environment variables set in the configuration preset. Example:
|
||||
suppose the host defaults to one compiler (say Clang) and the user
|
||||
wishes to use another compiler (say GCC). Set configuration preset
|
||||
environment variables :envvar:`CC` and :envvar:`CXX` and use a
|
||||
build preset that inherits that configuration preset. Otherwise the
|
||||
ExternalProject may use a different (system default) compiler than
|
||||
the top-level CMake project.
|
||||
properties: {}
|
||||
additionalProperties: *environment-additional-properties
|
||||
configurePreset:
|
||||
type: string
|
||||
minLength: 1
|
||||
description:
|
||||
An optional string specifying the name of a configure preset to
|
||||
associate with this build preset. If configurePreset is not
|
||||
specified, it must be inherited from the inherits preset (unless
|
||||
this preset is hidden). The build tree directory is inferred from
|
||||
the configure preset.
|
||||
sphinxDescription: |
|
||||
An optional string specifying the name of a configure preset to
|
||||
associate with this build preset. If ``configurePreset`` is not
|
||||
specified, it must be inherited from the inherits preset (unless
|
||||
this preset is hidden). The build directory is inferred from the
|
||||
configure preset, so the build will take place in the same
|
||||
``binaryDir`` that the configuration did.
|
||||
inheritConfigureEnvironment:
|
||||
type: boolean
|
||||
description:
|
||||
An optional boolean that defaults to true. If true, the environment
|
||||
variables from the associated configure preset are inherited after
|
||||
all inherited build preset environments, but before environment
|
||||
variables explicitly specified in this build preset.
|
||||
sphinxDescription: |
|
||||
An optional boolean that defaults to ``true``. If ``true``, the
|
||||
environment variables from the associated configure preset are
|
||||
inherited after all inherited build preset environments, but before
|
||||
environment variables explicitly specified in this build preset.
|
||||
jobs:
|
||||
type: integer
|
||||
description:
|
||||
An optional non-negative integer. Equivalent to passing --parallel
|
||||
or -j on the command line.
|
||||
sphinxDescription: |
|
||||
An optional integer. Equivalent to passing
|
||||
:cmake-build-option:`--parallel` or ``-j`` on the command line.
|
||||
If the value is ``0``, it is equivalent to passing ``--parallel``
|
||||
with ``<jobs>`` omitted; alternatively, one can define the
|
||||
environment variable :envvar:`CMAKE_BUILD_PARALLEL_LEVEL` as an
|
||||
empty string using the ``environment`` field.
|
||||
|
||||
.. versionchanged:: 4.3
|
||||
|
||||
This field does not accept negative integer values, regardless of
|
||||
the version in the preset file.
|
||||
minimum: 0
|
||||
targets:
|
||||
anyOf:
|
||||
- type: string
|
||||
description:
|
||||
An optional string. Equivalent to passing --target or -t on the
|
||||
command line. Vendors may ignore the targets property or hide
|
||||
build presets that explicitly specify targets.
|
||||
- type: array
|
||||
items:
|
||||
type: string
|
||||
description:
|
||||
An optional array of strings. Equivalent to passing --target or
|
||||
-t on the command line. Vendors may ignore the targets property
|
||||
or hide build presets that explicitly specify targets.
|
||||
sphinxDescription: |
|
||||
An optional string or array of strings. Equivalent to passing
|
||||
:cmake-build-option:`--target` or ``-t`` on the command line.
|
||||
Vendors may ignore the targets property or hide build presets that
|
||||
explicitly specify targets. This field supports `macro expansion`_.
|
||||
configuration:
|
||||
type: string
|
||||
description:
|
||||
An optional string. Equivalent to passing --config on the command
|
||||
line.
|
||||
sphinxDescription: |
|
||||
An optional string. Equivalent to passing
|
||||
:cmake-build-option:`--config` on the command line.
|
||||
cleanFirst:
|
||||
type: boolean
|
||||
description:
|
||||
An optional boolean. If true, equivalent to passing --clean-first
|
||||
on the command line.
|
||||
sphinxDescription: |
|
||||
An optional bool. If ``true``, equivalent to passing
|
||||
:cmake-build-option:`--clean-first` on the command line.
|
||||
resolvePackageReferences:
|
||||
since: 4
|
||||
type: string
|
||||
enum:
|
||||
- 'on'
|
||||
- 'off'
|
||||
- 'only'
|
||||
description:
|
||||
An optional string specifying the package resolve behavior. Valid
|
||||
values are "on" (packages are resolved prior to the build), "off"
|
||||
(packages are not resolved prior to the build), and "only"
|
||||
(packages are resolved, but no build will be performed).
|
||||
sphinxDescription: |
|
||||
An optional string that specifies the package resolve mode.
|
||||
|
||||
Package references are used to define dependencies to packages from
|
||||
external package managers. Currently only NuGet in combination with
|
||||
the :ref:`Visual Studio generators` is supported. If there are no
|
||||
targets that define package references, this option does nothing.
|
||||
Valid values are:
|
||||
|
||||
``on``
|
||||
Causes package references to be resolved before attempting a
|
||||
build.
|
||||
|
||||
``off``
|
||||
Package references will not be resolved. Note that this may cause
|
||||
errors in some build environments, such as .NET SDK style
|
||||
projects.
|
||||
|
||||
``only``
|
||||
Only resolve package references, but do not perform a build.
|
||||
|
||||
.. note::
|
||||
|
||||
The command line parameter
|
||||
:cmake-build-option:`--resolve-package-references`
|
||||
will take priority over this setting. If the command line
|
||||
parameter is not provided and this setting is not specified, an
|
||||
environment-specific cache variable will be evaluated to decide,
|
||||
if package restoration should be performed.
|
||||
|
||||
When using the :ref:`Visual Studio generators`,
|
||||
package references are defined using the
|
||||
:prop_tgt:`VS_PACKAGE_REFERENCES` property. Package references
|
||||
are restored using NuGet. It can be disabled by setting the
|
||||
:variable:`CMAKE_VS_NUGET_PACKAGE_RESTORE` variable to ``OFF``.
|
||||
This can also be done from within a configure preset.
|
||||
verbose:
|
||||
type: boolean
|
||||
description:
|
||||
An optional boolean. If true, equivalent to passing --verbose on
|
||||
the command line.
|
||||
sphinxDescription: |
|
||||
An optional boolean. If ``true``, equivalent to passing
|
||||
:cmake-build-option:`--verbose` on the command line.
|
||||
nativeToolOptions:
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
description:
|
||||
An optional array of strings. Equivalent to passing options after
|
||||
-- on the command line.
|
||||
sphinxDescription: |
|
||||
An optional array of strings. Equivalent to passing options after
|
||||
:cmake-build-option:`--` on the command line. The array values
|
||||
support `macro expansion`_.
|
||||
unevaluatedProperties: false
|
||||
testPresets:
|
||||
since: 2
|
||||
type: array
|
||||
description:
|
||||
An optional array of test preset objects. Used to specify arguments to
|
||||
ctest.
|
||||
sphinxDescription: |
|
||||
An optional array of `Test Preset`_ objects.
|
||||
items:
|
||||
type: object
|
||||
description:
|
||||
A test preset object.
|
||||
properties:
|
||||
name:
|
||||
type: string
|
||||
required: true
|
||||
minLength: 1
|
||||
description:
|
||||
A required string representing the machine-friendly name of the
|
||||
preset. This identifier is used in the ctest --preset option. 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,
|
||||
build, package, or workflow preset.
|
||||
sphinxDescription: |
|
||||
A required string representing the machine-friendly name of the
|
||||
preset. This identifier is used in the :option:`ctest --preset`
|
||||
option. 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, build, package, or workflow preset.
|
||||
hidden:
|
||||
type: boolean
|
||||
description:
|
||||
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 and does not have to have a valid configurePreset, even
|
||||
from inheritance. hidden presets are intended to be used as a base
|
||||
for other presets to inherit via the inherits field.
|
||||
sphinxDescription: |
|
||||
An optional boolean specifying whether or not a preset should be
|
||||
hidden. If a preset is hidden, it cannot be used in the
|
||||
:ctest-option:`--preset` argument and does not have to have a valid
|
||||
``configurePreset``, even from inheritance. ``hidden`` presets are
|
||||
intended to be used as a base for other presets to inherit via the
|
||||
``inherits`` field.
|
||||
inherits: *preset-inherits
|
||||
condition: *condition
|
||||
vendor: *preset-vendor
|
||||
displayName: *preset-displayName
|
||||
description: *preset-description
|
||||
environment: *preset-environment
|
||||
configurePreset:
|
||||
type: string
|
||||
minLength: 1
|
||||
description:
|
||||
An optional string specifying the name of a configure preset to
|
||||
associate with this test preset. If configurePreset is not
|
||||
specified, it must be inherited from the inherits preset (unless
|
||||
this preset is hidden). The build directory is inferred from the
|
||||
configure preset.
|
||||
sphinxDescription: |
|
||||
An optional string specifying the name of a configure preset to
|
||||
associate with this test preset. If ``configurePreset`` is not
|
||||
specified, it must be inherited from the inherits preset (unless
|
||||
this preset is hidden). The build directory is inferred from the
|
||||
configure preset, so tests will run in the same ``binaryDir`` that
|
||||
the configuration and build used.
|
||||
inheritConfigureEnvironment:
|
||||
type: boolean
|
||||
description:
|
||||
An optional boolean that defaults to true. If true, the environment
|
||||
variables from the associated configure preset are inherited after
|
||||
all inherited test preset environments, but before environment
|
||||
variables explicitly specified in this test preset.
|
||||
sphinxDescription: |
|
||||
An optional boolean that defaults to ``true``. If ``true``, the
|
||||
environment variables from the associated configure preset are
|
||||
inherited after all inherited test preset environments, but before
|
||||
environment variables explicitly specified in this test preset.
|
||||
configuration:
|
||||
type: string
|
||||
description:
|
||||
An optional string. Equivalent to passing --build-config on the
|
||||
command line.
|
||||
sphinxDescription: |
|
||||
An optional string. Equivalent to passing
|
||||
:ctest-option:`--build-config` on the command line.
|
||||
overwriteConfigurationFile:
|
||||
type: array
|
||||
description:
|
||||
An optional array of configuration options to overwrite options
|
||||
specified in the CTest configuration file. Equivalent to passing
|
||||
``--overwrite`` for each value in the array.
|
||||
sphinxDescription: |
|
||||
An optional array of configuration options to overwrite options
|
||||
specified in the CTest configuration file. Equivalent to passing
|
||||
:ctest-option:`--overwrite` for each value in the array. The array
|
||||
values support `macro expansion`_.
|
||||
items:
|
||||
type: string
|
||||
description:
|
||||
An option written as a key-value pair in the form "key=value".
|
||||
output:
|
||||
id: testOutput
|
||||
type: object
|
||||
description:
|
||||
An optional object specifying output options.
|
||||
sphinxDescription: |
|
||||
An optional object specifying output options.
|
||||
The object may contain the following fields:
|
||||
|
||||
.. include:: presets/testOutput-properties.rst
|
||||
properties:
|
||||
shortProgress:
|
||||
type: boolean
|
||||
description:
|
||||
An optional boolean. If true, equivalent to passing --progress
|
||||
on the command line.
|
||||
sphinxDescription: |
|
||||
An optional bool. If ``true``, equivalent to passing
|
||||
:ctest-option:`--progress` on the command line.
|
||||
verbosity:
|
||||
type: string
|
||||
enum:
|
||||
- default
|
||||
- verbose
|
||||
- extra
|
||||
description: '
|
||||
An optional string specifying verbosity level. Valid values are
|
||||
"default" (equivalent to passing no verbosity flags on the
|
||||
command line), "verbose" (equivalent to passing --verbose on
|
||||
the command line), and "extra" (equivalent to passing
|
||||
--extra-verbose on the command line).
|
||||
'
|
||||
sphinxDescription: |
|
||||
An optional string specifying verbosity level. Must be one of
|
||||
the following:
|
||||
|
||||
``default``
|
||||
Equivalent to passing no verbosity flags on the command line.
|
||||
|
||||
``verbose``
|
||||
Equivalent to passing :ctest-option:`--verbose` on the
|
||||
command line.
|
||||
|
||||
``extra``
|
||||
Equivalent to passing :ctest-option:`--extra-verbose` on the
|
||||
command line.
|
||||
debug:
|
||||
type: boolean
|
||||
description:
|
||||
An optional boolean. If true, equivalent to passing --debug on
|
||||
the command line.
|
||||
sphinxDescription: |
|
||||
An optional bool. If ``true``, equivalent to passing
|
||||
:ctest-option:`--debug` on the command line.
|
||||
outputOnFailure:
|
||||
type: boolean
|
||||
description:
|
||||
An optional boolean. If true, equivalent to passing
|
||||
--output-on-failure on the command line.
|
||||
sphinxDescription: |
|
||||
An optional bool. If ``true``, equivalent to passing
|
||||
:ctest-option:`--output-on-failure` on the command line.
|
||||
quiet:
|
||||
type: boolean
|
||||
description:
|
||||
An optional boolean. If true, equivalent to passing --quiet on
|
||||
the command line.
|
||||
sphinxDescription: |
|
||||
An optional bool. If ``true``, equivalent to passing
|
||||
:ctest-option:`--quiet` on the command line.
|
||||
outputLogFile:
|
||||
type: string
|
||||
description:
|
||||
An optional string specifying a path to a log file. Equivalent
|
||||
to passing --output-log on the command line.
|
||||
sphinxDescription: |
|
||||
An optional string specifying a path to a log file. Equivalent
|
||||
to passing :ctest-option:`--output-log` on the command line.
|
||||
This field supports `macro expansion`_.
|
||||
outputJUnitFile:
|
||||
since: 6
|
||||
type: string
|
||||
description:
|
||||
An optional string specifying a path to a JUnit file.
|
||||
Equivalent to passing --output-junit on the command line.
|
||||
sphinxDescription: |
|
||||
An optional string specifying a path to a JUnit file.
|
||||
Equivalent to passing :ctest-option:`--output-junit` on the
|
||||
command line. This field supports `macro expansion`_.
|
||||
labelSummary:
|
||||
type: boolean
|
||||
description:
|
||||
An optional boolean. If false, equivalent to passing
|
||||
--no-label-summary on the command line.
|
||||
sphinxDescription: |
|
||||
An optional bool. If ``false``, equivalent to passing
|
||||
:ctest-option:`--no-label-summary` on the command line.
|
||||
subprojectSummary:
|
||||
type: boolean
|
||||
description:
|
||||
An optional boolean. If false, equivalent to passing
|
||||
--no-subproject-summary on the command line.
|
||||
sphinxDescription: |
|
||||
An optional bool. If ``false``, equivalent to passing
|
||||
:ctest-option:`--no-subproject-summary` on the command line.
|
||||
maxPassedTestOutputSize:
|
||||
type: integer
|
||||
description:
|
||||
An optional integer specifying the maximum output for passed
|
||||
tests in bytes. Equivalent to passing --test-output-size-passed
|
||||
on the command line.
|
||||
sphinxDescription: |
|
||||
An optional integer specifying the maximum output for passed
|
||||
tests in bytes. Equivalent to passing
|
||||
:ctest-option:`--test-output-size-passed` on the command line.
|
||||
maxFailedTestOutputSize:
|
||||
type: integer
|
||||
description:
|
||||
An optional integer specifying the maximum output for failed
|
||||
tests in bytes. Equivalent to passing --test-output-size-failed
|
||||
on the command line.
|
||||
sphinxDescription: |
|
||||
An optional integer specifying the maximum output for failed
|
||||
tests in bytes. Equivalent to passing
|
||||
:ctest-option:`--test-output-size-failed` on the command line.
|
||||
testOutputTruncation:
|
||||
since: 5
|
||||
type: string
|
||||
enum:
|
||||
- tail
|
||||
- middle
|
||||
- head
|
||||
description: '
|
||||
An optional string specifying the test output truncation mode.
|
||||
Equivalent to passing --test-output-truncation on the command
|
||||
line. Must be one of the following values: "tail", "middle", or
|
||||
"head".
|
||||
'
|
||||
sphinxDescription: |
|
||||
An optional string specifying the test output truncation mode.
|
||||
Equivalent to passing :ctest-option:`--test-output-truncation`
|
||||
on the command line. Must be one of the following values:
|
||||
|
||||
* ``tail``
|
||||
|
||||
* ``middle``
|
||||
|
||||
* ``head``
|
||||
maxTestNameWidth:
|
||||
type: integer
|
||||
description:
|
||||
An optional integer specifying the maximum width of a test name
|
||||
to output. Equivalent to passing --max-width on the command
|
||||
line.
|
||||
sphinxDescription: |
|
||||
An optional integer specifying the maximum width of a test name
|
||||
to output. Equivalent to passing :ctest-option:`--max-width` on
|
||||
the command line.
|
||||
unevaluatedProperties: false
|
||||
filter:
|
||||
type: object
|
||||
description:
|
||||
An optional object specifying how to filter the tests to run.
|
||||
sphinxDescription: |
|
||||
An optional object specifying how to filter the tests to run.
|
||||
The object may contain the following fields:
|
||||
|
||||
.. include:: presets/filter-properties.rst
|
||||
properties:
|
||||
include:
|
||||
type: object
|
||||
description:
|
||||
An optional object specifying which tests to include.
|
||||
sphinxDescription: |
|
||||
An optional object specifying which tests to include.
|
||||
The object may contain the following fields:
|
||||
|
||||
.. include:: presets/include-properties.rst
|
||||
properties:
|
||||
name:
|
||||
type: string
|
||||
description:
|
||||
An optional string specifying a regex for test names.
|
||||
Equivalent to passing --tests-regex on the command line.
|
||||
sphinxDescription: |
|
||||
An optional string specifying a regex for test names.
|
||||
Equivalent to passing :ctest-option:`--tests-regex` on the
|
||||
command line. This field supports `macro expansion`_.
|
||||
|
||||
CMake regex syntax is described under
|
||||
:ref:`string(REGEX) <Regex Specification>`.
|
||||
label:
|
||||
type: string
|
||||
description:
|
||||
An optional string specifying a regex for test labels.
|
||||
Equivalent to passing --label-regex on the command line.
|
||||
sphinxDescription: |
|
||||
An optional string specifying a regex for test labels.
|
||||
Equivalent to passing :ctest-option:`--label-regex` on the
|
||||
command line. This field supports `macro expansion`_.
|
||||
useUnion:
|
||||
type: boolean
|
||||
description:
|
||||
An optional boolean. Equivalent to passing --union on the
|
||||
command line.
|
||||
sphinxDescription: |
|
||||
An optional bool. Equivalent to passing
|
||||
:ctest-option:`--union` on the command line.
|
||||
index:
|
||||
anyOf:
|
||||
- type: string
|
||||
description:
|
||||
An optional string specifying a file with the command
|
||||
line syntax for --tests-information. Available in
|
||||
version 2 and higher.
|
||||
- type: object
|
||||
description:
|
||||
An optional object specifying test preset filters.
|
||||
Available in version 2 and higher.
|
||||
properties:
|
||||
start:
|
||||
type: integer
|
||||
description:
|
||||
An optional integer specifying a test index at
|
||||
which to start testing.
|
||||
end:
|
||||
type: integer
|
||||
description:
|
||||
An optional integer specifying a test index at
|
||||
which to stop testing.
|
||||
stride:
|
||||
type: integer
|
||||
description:
|
||||
An optional integer specifying the increment.
|
||||
specificTests:
|
||||
type: array
|
||||
description:
|
||||
An optional array of integers specifying specific
|
||||
test indices to run.
|
||||
items:
|
||||
type: integer
|
||||
description:
|
||||
An integer specifying the test to run by index.
|
||||
unevaluatedProperties: false
|
||||
sphinxDescription: |
|
||||
An optional object specifying tests to include by test
|
||||
index. The object may contain the following fields. Can
|
||||
also be an optional string specifying a file with the
|
||||
command line syntax for
|
||||
:ctest-option:`--tests-information`. If specified as a
|
||||
string, this field supports `macro expansion`_.
|
||||
|
||||
.. include:: presets/index-properties.rst
|
||||
exclude:
|
||||
type: object
|
||||
description:
|
||||
An optional object specifying which tests to exclude.
|
||||
sphinxDescription: |
|
||||
An optional object specifying which tests to exclude.
|
||||
The object may contain the following fields:
|
||||
|
||||
.. include:: presets/exclude-properties.rst
|
||||
properties:
|
||||
name:
|
||||
type: string
|
||||
description:
|
||||
An optional string specifying a regex for test names.
|
||||
Equivalent to passing --exclude-regex on the command line.
|
||||
sphinxDescription: |
|
||||
An optional string specifying a regex for test names.
|
||||
Equivalent to passing :ctest-option:`--exclude-regex` on
|
||||
the command line. This field supports `macro expansion`_.
|
||||
label:
|
||||
type: string
|
||||
description:
|
||||
An optional string specifying a regex for test labels.
|
||||
Equivalent to passing --label-exclude on the command line.
|
||||
sphinxDescription: |
|
||||
An optional string specifying a regex for test labels.
|
||||
Equivalent to passing :ctest-option:`--label-exclude` on
|
||||
the command line. This field supports `macro expansion`_.
|
||||
fixtures:
|
||||
type: object
|
||||
description:
|
||||
An optional object specifying which fixtures to exclude
|
||||
from adding tests.
|
||||
sphinxDescription: |
|
||||
An optional object specifying which fixtures to exclude
|
||||
from adding tests. The object may contain the following
|
||||
fields:
|
||||
|
||||
.. include:: presets/fixtures-properties.rst
|
||||
properties:
|
||||
any:
|
||||
type: string
|
||||
description:
|
||||
An optional string specifying a regex for text fixtures
|
||||
to exclude from adding any tests. Equivalent to passing
|
||||
--fixture-exclude-any on the command line.
|
||||
sphinxDescription: |
|
||||
An optional string specifying a regex for text fixtures
|
||||
to exclude from adding any tests. Equivalent to passing
|
||||
:ctest-option:`--fixture-exclude-any` on the command
|
||||
line. This field supports `macro expansion`_.
|
||||
setup:
|
||||
type: string
|
||||
description:
|
||||
An optional string specifying a regex for text fixtures
|
||||
to exclude from adding setup tests. Equivalent to
|
||||
passing --fixture-exclude-setup on the command line.
|
||||
sphinxDescription: |
|
||||
An optional string specifying a regex for text fixtures
|
||||
to exclude from adding setup tests. Equivalent to
|
||||
passing :ctest-option:`--fixture-exclude-setup` on the
|
||||
command line. This field supports `macro expansion`_.
|
||||
cleanup:
|
||||
type: string
|
||||
description:
|
||||
An optional string specifying a regex for text fixtures
|
||||
to exclude from adding cleanup tests. Equivalent to
|
||||
passing --fixture-exclude-cleanup on the command line.
|
||||
sphinxDescription: |
|
||||
An optional string specifying a regex for text fixtures
|
||||
to exclude from adding cleanup tests. Equivalent to
|
||||
passing :ctest-option:`--fixture-exclude-cleanup` on
|
||||
the command line.
|
||||
This field supports `macro expansion`_.
|
||||
execution:
|
||||
type: object
|
||||
description:
|
||||
An optional object specifying options for test execution.
|
||||
sphinxDescription: |
|
||||
An optional object specifying options for test execution.
|
||||
The object may contain the following fields:
|
||||
|
||||
.. include:: presets/execution-properties.rst
|
||||
properties:
|
||||
stopOnFailure:
|
||||
type: boolean
|
||||
description:
|
||||
An optional boolean. If true, equivalent to passing
|
||||
--stop-on-failure on the command line.
|
||||
sphinxDescription: |
|
||||
An optional bool. If ``true``, equivalent to passing
|
||||
:ctest-option:`--stop-on-failure` on the command line.
|
||||
enableFailover:
|
||||
type: boolean
|
||||
description:
|
||||
An optional boolean. If true, equivalent to passing -F on the
|
||||
command line.
|
||||
sphinxDescription: |
|
||||
An optional bool. If ``true``, equivalent to passing
|
||||
:ctest-option:`-F` on the command line.
|
||||
jobs:
|
||||
revisions:
|
||||
- until: 11
|
||||
type: integer
|
||||
minimum: 0
|
||||
description:
|
||||
An optional non-negative integer. Equivalent to passing
|
||||
--parallel or -j on the command line.
|
||||
- since: 11
|
||||
anyOf:
|
||||
- type: integer
|
||||
minimum: 0
|
||||
description:
|
||||
An optional non-negative integer. Equivalent to passing
|
||||
--parallel or -j on the command line.
|
||||
- type: string
|
||||
minLength: 0
|
||||
maxLength: 0
|
||||
description:
|
||||
An optional string. Equivalent to passing --parallel or
|
||||
-j on the command line with the number of jobs omitted.
|
||||
sphinxDescription: |
|
||||
An optional integer. Equivalent to passing
|
||||
:ctest-option:`--parallel` on the command line. If the value is
|
||||
``0``, it is equivalent to unbounded parallelism.
|
||||
|
||||
.. presets-versionchanged:: 11
|
||||
|
||||
This field can also be a string, in which case it must be
|
||||
empty, and is equivalent to passing ``--parallel`` with
|
||||
``<jobs>`` omitted.
|
||||
|
||||
.. versionchanged:: 4.3
|
||||
|
||||
This field does not accept negative integer values,
|
||||
regardless of the version in the preset file.
|
||||
minimum: 0
|
||||
resourceSpecFile:
|
||||
type: string
|
||||
description:
|
||||
An optional string. Equivalent to passing --resource-spec-file
|
||||
on the command line.
|
||||
sphinxDescription: |
|
||||
An optional string. Equivalent to passing
|
||||
:ctest-option:`--resource-spec-file` on the command line. This
|
||||
field supports `macro expansion`_.
|
||||
testLoad:
|
||||
type: integer
|
||||
description:
|
||||
An optional integer. Equivalent to passing --test-load on the
|
||||
command line.
|
||||
sphinxDescription: |
|
||||
An optional integer. Equivalent to passing
|
||||
:ctest-option:`--test-load` on the command line.
|
||||
showOnly:
|
||||
type: string
|
||||
enum:
|
||||
- human
|
||||
- json-v1
|
||||
description:
|
||||
An optional string. Equivalent to passing --show-only on the
|
||||
command line. Value must be "human" or "json-v1".
|
||||
sphinxDescription: |
|
||||
An optional string. Equivalent to passing
|
||||
:ctest-option:`--show-only` on the command line. The string
|
||||
must be one of the following values:
|
||||
|
||||
* ``human``
|
||||
|
||||
* ``json-v1``
|
||||
repeat:
|
||||
type: object
|
||||
description:
|
||||
An optional object specifying how to repeat tests. Equivalent
|
||||
to passing --repeat on the command line.
|
||||
sphinxDescription: |
|
||||
An optional object specifying how to repeat tests. Equivalent
|
||||
to passing :ctest-option:`--repeat` on the command line.
|
||||
The object must have the following fields:
|
||||
|
||||
.. include:: presets/repeat-properties.rst
|
||||
properties:
|
||||
mode:
|
||||
type: string
|
||||
required: true
|
||||
enum:
|
||||
- until-fail
|
||||
- until-pass
|
||||
- after-timeout
|
||||
description: '
|
||||
A required string. Must be one of the following values:
|
||||
"until-fail", "until-pass", or "after-timeout".
|
||||
'
|
||||
sphinxDescription: |
|
||||
A required string. Must be one of the following values:
|
||||
|
||||
* ``until-fail``
|
||||
|
||||
* ``until-pass``
|
||||
|
||||
* ``after-timeout``
|
||||
count:
|
||||
type: integer
|
||||
required: true
|
||||
description:
|
||||
A required integer.
|
||||
unevaluatedProperties: false
|
||||
interactiveDebugging:
|
||||
type: boolean
|
||||
description:
|
||||
An optional boolean. If true, equivalent to passing
|
||||
--interactive-debug-mode 1 on the command line. If false,
|
||||
equivalent to passing --interactive-debug-mode 0 on the
|
||||
command line.
|
||||
sphinxDescription: |
|
||||
An optional bool. If ``true``, equivalent to passing
|
||||
:ctest-option:`--interactive-debug-mode 1` on the command line.
|
||||
If ``false``, equivalent to passing
|
||||
:ctest-option:`--interactive-debug-mode 0` on the command line.
|
||||
scheduleRandom:
|
||||
type: boolean
|
||||
description:
|
||||
An optional boolean. If true, equivalent to passing
|
||||
--schedule-random on the command line.
|
||||
sphinxDescription: |
|
||||
An optional bool. If ``true``, equivalent to passing
|
||||
:ctest-option:`--schedule-random` on the command line.
|
||||
timeout:
|
||||
type: integer
|
||||
description:
|
||||
An optional integer. Equivalent to passing --timeout on the
|
||||
command line.
|
||||
sphinxDescription: |
|
||||
An optional integer. Equivalent to passing
|
||||
:ctest-option:`--timeout` on the command line.
|
||||
noTestsAction:
|
||||
type: string
|
||||
enum:
|
||||
- default
|
||||
- error
|
||||
- ignore
|
||||
description: '
|
||||
An optional string specifying the behavior if no tests are
|
||||
found. Must be one of the following values: "default"
|
||||
(equivalent to not passing any value on the command line),
|
||||
"error" (equivalent to passing --no-tests=error on the command
|
||||
line), or "ignore" (equivalent to passing --no-tests-ignore on
|
||||
the command line).
|
||||
'
|
||||
sphinxDescription: |
|
||||
An optional string specifying the behavior if no tests are
|
||||
found. Must be one of the following values:
|
||||
|
||||
``default``
|
||||
Equivalent to not passing any value on the command line.
|
||||
|
||||
``error``
|
||||
Equivalent to passing :ctest-option:`--no-tests=error`
|
||||
on the command line.
|
||||
|
||||
``ignore``
|
||||
Equivalent to passing :ctest-option:`--no-tests=ignore`
|
||||
on the command line.
|
||||
testPassthroughArguments:
|
||||
since: 12
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
description:
|
||||
An optional array of strings. Each element is forwarded as an
|
||||
argument to every test executable. Equivalent to passing
|
||||
arguments after -- on the ctest command line.
|
||||
sphinxDescription: |
|
||||
An optional array of strings. Each element is forwarded as an
|
||||
argument to every test executable, equivalent to passing
|
||||
arguments after :option:`ctest --` on the command line.
|
||||
|
||||
When both preset and command-line passthrough arguments are
|
||||
specified, preset arguments appear first, followed by
|
||||
command-line arguments.
|
||||
unevaluatedProperties: false
|
||||
unevaluatedProperties: false
|
||||
packagePresets:
|
||||
since: 6
|
||||
type: array
|
||||
description:
|
||||
An optional array of package preset objects. Used to specify arguments to
|
||||
cpack.
|
||||
sphinxDescription: |
|
||||
An optional array of `Package Preset`_ objects.
|
||||
items:
|
||||
type: object
|
||||
description:
|
||||
A package preset object.
|
||||
properties:
|
||||
name:
|
||||
type: string
|
||||
required: true
|
||||
minLength: 1
|
||||
description:
|
||||
A required string representing the machine-friendly name of the
|
||||
preset. This identifier is used in the cpack --preset option. There
|
||||
must not be two package presets in the union of CMakePresets.json
|
||||
and CMakeUserPresets.json in the same directory with the same name.
|
||||
However, a package preset may have the same name as a configure,
|
||||
build, test, or workflow preset.
|
||||
sphinxDescription: |
|
||||
A required string representing the machine-friendly name of the
|
||||
preset. This identifier is used in the :option:`cpack --preset`
|
||||
option. There must not be two package presets in the union of
|
||||
``CMakePresets.json`` and ``CMakeUserPresets.json`` in the same
|
||||
directory with the same name. However, a package preset may have
|
||||
the same name as a configure, build, test, or workflow preset.
|
||||
hidden:
|
||||
type: boolean
|
||||
description:
|
||||
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 and does not have to have a valid configurePreset, even
|
||||
from inheritance. hidden presets are intended to be used as a base
|
||||
for other presets to inherit via the inherits field.
|
||||
sphinxDescription: |
|
||||
An optional boolean specifying whether or not a preset should be
|
||||
hidden. If a preset is hidden, it cannot be used in the
|
||||
:cpack-option:`--preset` argument and does not have to have a valid
|
||||
``configurePreset``, even from inheritance. ``hidden`` presets are
|
||||
intended to be used as a base for other presets to inherit via the
|
||||
``inherits`` field.
|
||||
inherits: *preset-inherits
|
||||
condition: *condition
|
||||
vendor: *preset-vendor
|
||||
displayName: *preset-displayName
|
||||
description: *preset-description
|
||||
environment: *preset-environment
|
||||
configurePreset:
|
||||
type: string
|
||||
minLength: 1
|
||||
description:
|
||||
An optional string specifying the name of a configure preset to
|
||||
associate with this package preset. If configurePreset is not
|
||||
specified, it must be inherited from the inherits preset (unless
|
||||
this preset is hidden). The build tree directory is inferred from
|
||||
the configure preset.
|
||||
sphinxDescription: |
|
||||
An optional string specifying the name of a configure preset to
|
||||
associate with this package preset. If ``configurePreset`` is not
|
||||
specified, it must be inherited from the inherits preset (unless
|
||||
this preset is hidden). The build directory is inferred from the
|
||||
configure preset, so packaging will run in the same ``binaryDir``
|
||||
that the configuration did and build did.
|
||||
inheritConfigureEnvironment:
|
||||
type: boolean
|
||||
description:
|
||||
An optional boolean that defaults to true. If true, the environment
|
||||
variables from the associated configure preset are inherited after
|
||||
all inherited package preset environments, but before environment
|
||||
variables explicitly specified in this package preset.
|
||||
sphinxDescription: |
|
||||
An optional boolean that defaults to ``true``. If ``true``, the
|
||||
environment variables from the associated configure preset are
|
||||
inherited after all inherited package preset environments, but
|
||||
before environment variables explicitly specified in this package
|
||||
preset.
|
||||
generators:
|
||||
type: array
|
||||
description:
|
||||
An optional array of strings representing generators for CPack to
|
||||
use.
|
||||
items:
|
||||
type: string
|
||||
description:
|
||||
An optional string representing the name of a CPack generator
|
||||
to use.
|
||||
configurations:
|
||||
type: array
|
||||
description:
|
||||
An optional array of strings representing build configurations for
|
||||
CPack to package.
|
||||
items:
|
||||
type: string
|
||||
description:
|
||||
An optional string representing the name of a configuration to
|
||||
package.
|
||||
variables:
|
||||
type: object
|
||||
description:
|
||||
An optional map of variables to pass to CPack, equivalent to -D
|
||||
arguments. Each key is the name of a variable, and the value is the
|
||||
string to assign to that variable.
|
||||
sphinxDescription: |
|
||||
An optional map of variables to pass to CPack, equivalent to
|
||||
:cpack-option:`-D` arguments. Each key is the name of a variable,
|
||||
and the value is the string to assign to that variable.
|
||||
properties: {}
|
||||
propertyNames:
|
||||
pattern: '^.+$'
|
||||
additionalProperties:
|
||||
type: string
|
||||
description:
|
||||
An optional string representing the value of the variable.
|
||||
configFile:
|
||||
type: string
|
||||
description:
|
||||
An optional string representing the config file for CPack to use.
|
||||
output:
|
||||
id: packageOutput
|
||||
type: object
|
||||
description:
|
||||
An optional object specifying output options.
|
||||
sphinxDescription: |
|
||||
An optional object specifying output options. Valid keys are:
|
||||
|
||||
.. include:: presets/packageOutput-properties.rst
|
||||
properties:
|
||||
debug:
|
||||
type: boolean
|
||||
description:
|
||||
An optional boolean specifying whether or not to print debug
|
||||
information. A value of true is equivalent to passing --debug
|
||||
on the command line.
|
||||
sphinxDescription: |
|
||||
An optional boolean specifying whether or not to print debug
|
||||
information. A value of ``true`` is equivalent to passing
|
||||
:cpack-option:`--debug` on the command line.
|
||||
verbose:
|
||||
type: boolean
|
||||
description:
|
||||
An optional boolean specifying whether or not to print
|
||||
verbosely. A value of true is equivalent to passing --verbose
|
||||
on the command line.
|
||||
sphinxDescription: |
|
||||
An optional boolean specifying whether or not to print
|
||||
verbosely. A value of ``true`` is equivalent to passing
|
||||
:cpack-option:`--verbose` on the command line.
|
||||
unevaluatedProperties: false
|
||||
packageName:
|
||||
type: string
|
||||
description:
|
||||
An optional string representing the package name.
|
||||
sphinxNote: &package-naming-note |
|
||||
Due to problems with the implementation, this field does not affect
|
||||
the name of the final package file produced. However, other aspects
|
||||
of the package may use the value, leading to inconsistencies. A
|
||||
future CMake release may address this problem, but until then, it
|
||||
is recommended that this field not be used.
|
||||
packageVersion:
|
||||
type: string
|
||||
description:
|
||||
An optional string representing the package version.
|
||||
sphinxNote: *package-naming-note
|
||||
packageDirectory:
|
||||
type: string
|
||||
description:
|
||||
An optional string representing the directory in which to place the
|
||||
package.
|
||||
vendorName:
|
||||
type: string
|
||||
description:
|
||||
An optional string representing the vendor name.
|
||||
unevaluatedProperties: false
|
||||
workflowPresets:
|
||||
since: 6
|
||||
type: array
|
||||
description:
|
||||
An optional array of workflow preset objects. Used to execute configure,
|
||||
build, test, and package presets in order.
|
||||
sphinxDescription: |
|
||||
An optional array of `Workflow Preset`_ objects.
|
||||
items:
|
||||
type: object
|
||||
description:
|
||||
A workflow preset object.
|
||||
properties:
|
||||
name:
|
||||
type: string
|
||||
required: true
|
||||
minLength: 1
|
||||
description:
|
||||
A required string representing the machine-friendly name of the
|
||||
preset. This identifier is used in the cmake --workflow --preset
|
||||
option. There must not be two presets (configure, build, test,
|
||||
package, or workflow) in the union of CMakePresets.json and
|
||||
CMakeUserPresets.json in the same directory with the same name.
|
||||
However, a workflow preset may have the same name as a configure,
|
||||
build, test, or package preset.
|
||||
sphinxDescription: |
|
||||
A required string representing the machine-friendly name of the
|
||||
preset. This identifier is used in the
|
||||
:option:`cmake --workflow --preset <cmake--workflow --preset>`
|
||||
option. There must not be two workflow presets in the union of
|
||||
``CMakePresets.json`` and ``CMakeUserPresets.json`` in the same
|
||||
directory with the same name. However, a workflow preset may have
|
||||
the same name as a configure, build, test, or package preset.
|
||||
vendor: *preset-vendor
|
||||
displayName: *preset-displayName
|
||||
description: *preset-description
|
||||
steps:
|
||||
type: array
|
||||
required: true
|
||||
description:
|
||||
A required array of objects describing the steps of the workflow.
|
||||
The first step must be a configure preset, and all subsequent steps
|
||||
must be non-configure presets whose configurePreset field matches
|
||||
the starting configure preset.
|
||||
sphinxDescription: |
|
||||
A required array of objects describing the steps of the workflow.
|
||||
The first step must be a configure preset, and all subsequent steps
|
||||
must be non-configure presets whose ``configurePreset`` field
|
||||
matches the starting configure preset. Each object may contain the
|
||||
following fields:
|
||||
|
||||
.. include:: presets/steps-properties.rst
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
enum:
|
||||
- configure
|
||||
- build
|
||||
- test
|
||||
- package
|
||||
description:
|
||||
A required string. The first step must be configure.
|
||||
Subsequent steps must be either build, test, or package.
|
||||
sphinxDescription: |
|
||||
A required string. The first step must be ``configure``.
|
||||
Subsequent steps must be either ``build``, ``test``, or
|
||||
``package``.
|
||||
name:
|
||||
type: string
|
||||
minLength: 1
|
||||
description:
|
||||
A required string representing the name of the configure,
|
||||
build, test, or package preset to run as this workflow step.
|
||||
unevaluatedProperties: false
|
||||
unevaluatedProperties: false
|
||||
additionalProperties: false
|
||||
@@ -0,0 +1,14 @@
|
||||
.. This file was generated by Utilities/Scripts/regenerate-presets.py
|
||||
from Help/manual/presets/schema.yaml. Do not edit.
|
||||
|
||||
.. _`CMakePresets.workflowPresets.steps.type`:
|
||||
|
||||
``type``
|
||||
A required string. The first step must be ``configure``.
|
||||
Subsequent steps must be either ``build``, ``test``, or
|
||||
``package``.
|
||||
|
||||
.. _`CMakePresets.workflowPresets.steps.name`:
|
||||
|
||||
``name``
|
||||
A required string representing the name of the configure, build, test, or package preset to run as this workflow step.
|
||||
@@ -0,0 +1,107 @@
|
||||
.. This file was generated by Utilities/Scripts/regenerate-presets.py
|
||||
from Help/manual/presets/schema.yaml. Do not edit.
|
||||
|
||||
.. _`CMakePresets.testPresets.output.shortProgress`:
|
||||
|
||||
``shortProgress``
|
||||
An optional bool. If ``true``, equivalent to passing
|
||||
:ctest-option:`--progress` on the command line.
|
||||
|
||||
.. _`CMakePresets.testPresets.output.verbosity`:
|
||||
|
||||
``verbosity``
|
||||
An optional string specifying verbosity level. Must be one of
|
||||
the following:
|
||||
|
||||
``default``
|
||||
Equivalent to passing no verbosity flags on the command line.
|
||||
|
||||
``verbose``
|
||||
Equivalent to passing :ctest-option:`--verbose` on the
|
||||
command line.
|
||||
|
||||
``extra``
|
||||
Equivalent to passing :ctest-option:`--extra-verbose` on the
|
||||
command line.
|
||||
|
||||
.. _`CMakePresets.testPresets.output.debug`:
|
||||
|
||||
``debug``
|
||||
An optional bool. If ``true``, equivalent to passing
|
||||
:ctest-option:`--debug` on the command line.
|
||||
|
||||
.. _`CMakePresets.testPresets.output.outputOnFailure`:
|
||||
|
||||
``outputOnFailure``
|
||||
An optional bool. If ``true``, equivalent to passing
|
||||
:ctest-option:`--output-on-failure` on the command line.
|
||||
|
||||
.. _`CMakePresets.testPresets.output.quiet`:
|
||||
|
||||
``quiet``
|
||||
An optional bool. If ``true``, equivalent to passing
|
||||
:ctest-option:`--quiet` on the command line.
|
||||
|
||||
.. _`CMakePresets.testPresets.output.outputLogFile`:
|
||||
|
||||
``outputLogFile``
|
||||
An optional string specifying a path to a log file. Equivalent
|
||||
to passing :ctest-option:`--output-log` on the command line.
|
||||
This field supports `macro expansion`_.
|
||||
|
||||
.. _`CMakePresets.testPresets.output.outputJUnitFile`:
|
||||
|
||||
``outputJUnitFile``
|
||||
.. presets-versionadded:: 6
|
||||
|
||||
An optional string specifying a path to a JUnit file.
|
||||
Equivalent to passing :ctest-option:`--output-junit` on the
|
||||
command line. This field supports `macro expansion`_.
|
||||
|
||||
.. _`CMakePresets.testPresets.output.labelSummary`:
|
||||
|
||||
``labelSummary``
|
||||
An optional bool. If ``false``, equivalent to passing
|
||||
:ctest-option:`--no-label-summary` on the command line.
|
||||
|
||||
.. _`CMakePresets.testPresets.output.subprojectSummary`:
|
||||
|
||||
``subprojectSummary``
|
||||
An optional bool. If ``false``, equivalent to passing
|
||||
:ctest-option:`--no-subproject-summary` on the command line.
|
||||
|
||||
.. _`CMakePresets.testPresets.output.maxPassedTestOutputSize`:
|
||||
|
||||
``maxPassedTestOutputSize``
|
||||
An optional integer specifying the maximum output for passed
|
||||
tests in bytes. Equivalent to passing
|
||||
:ctest-option:`--test-output-size-passed` on the command line.
|
||||
|
||||
.. _`CMakePresets.testPresets.output.maxFailedTestOutputSize`:
|
||||
|
||||
``maxFailedTestOutputSize``
|
||||
An optional integer specifying the maximum output for failed
|
||||
tests in bytes. Equivalent to passing
|
||||
:ctest-option:`--test-output-size-failed` on the command line.
|
||||
|
||||
.. _`CMakePresets.testPresets.output.testOutputTruncation`:
|
||||
|
||||
``testOutputTruncation``
|
||||
.. presets-versionadded:: 5
|
||||
|
||||
An optional string specifying the test output truncation mode.
|
||||
Equivalent to passing :ctest-option:`--test-output-truncation`
|
||||
on the command line. Must be one of the following values:
|
||||
|
||||
* ``tail``
|
||||
|
||||
* ``middle``
|
||||
|
||||
* ``head``
|
||||
|
||||
.. _`CMakePresets.testPresets.output.maxTestNameWidth`:
|
||||
|
||||
``maxTestNameWidth``
|
||||
An optional integer specifying the maximum width of a test name
|
||||
to output. Equivalent to passing :ctest-option:`--max-width` on
|
||||
the command line.
|
||||
@@ -0,0 +1,146 @@
|
||||
.. This file was generated by Utilities/Scripts/regenerate-presets.py
|
||||
from Help/manual/presets/schema.yaml. Do not edit.
|
||||
|
||||
.. _`CMakePresets.testPresets.name`:
|
||||
|
||||
``name``
|
||||
A required string representing the machine-friendly name of the
|
||||
preset. This identifier is used in the :option:`ctest --preset`
|
||||
option. 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, build, package, or workflow preset.
|
||||
|
||||
.. _`CMakePresets.testPresets.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
|
||||
:ctest-option:`--preset` argument and does not have to have a valid
|
||||
``configurePreset``, even from inheritance. ``hidden`` presets are
|
||||
intended to be used as a base for other presets to inherit via the
|
||||
``inherits`` field.
|
||||
|
||||
.. _`CMakePresets.testPresets.inherits`:
|
||||
|
||||
``inherits``
|
||||
An optional array of strings representing the names of presets from which
|
||||
to inherit. This field can also be a string, which is equivalent to an
|
||||
array containing one string.
|
||||
|
||||
The preset will inherit all of the fields from the ``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`` array will be preferred.
|
||||
|
||||
A preset can only inherit from another preset that is defined in the same
|
||||
file or in one of the files it includes (directly or indirectly). Presets
|
||||
in ``CMakePresets.json`` may not inherit from presets in
|
||||
``CMakeUserPresets.json``.
|
||||
|
||||
.. _`CMakePresets.testPresets.condition`:
|
||||
|
||||
``condition``
|
||||
.. presets-versionadded:: 3
|
||||
|
||||
An optional `Condition`_ object.
|
||||
|
||||
.. _`CMakePresets.testPresets.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 if
|
||||
it does exist. However, it should follow the same conventions as the
|
||||
root-level ``vendor`` field. If vendors use their own per-preset
|
||||
``vendor`` field, they should implement inheritance in a sensible manner
|
||||
when appropriate.
|
||||
|
||||
.. _`CMakePresets.testPresets.displayName`:
|
||||
|
||||
``displayName``
|
||||
An optional string with a human-friendly name of the preset.
|
||||
|
||||
.. _`CMakePresets.testPresets.description`:
|
||||
|
||||
``description``
|
||||
An optional string with a human-friendly description of the preset.
|
||||
|
||||
.. _`CMakePresets.testPresets.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 a
|
||||
string representing the value of the variable. Each variable is set
|
||||
regardless of whether or not a value was given to it by the process's
|
||||
environment.
|
||||
|
||||
This field supports `macro expansion`_, and environment variables in this
|
||||
map may reference each other, and may be listed in any order, as long as
|
||||
such references do not cause a cycle (for example, if ``ENV_1`` is
|
||||
``$env{ENV_2}``, ``ENV_2`` may not be ``$env{ENV_1}``). ``$penv{NAME}``
|
||||
allows one to prepend or append values to existing environment variables
|
||||
by accessing only values from the parent environment.
|
||||
|
||||
Environment variables are inherited through the ``inherits`` field, and
|
||||
the preset's environment will be the union of its own ``environment`` and
|
||||
the ``environment`` from all its parents. If multiple presets in this
|
||||
union define the same variable, the standard rules of ``inherits`` are
|
||||
applied. Setting a variable to ``null`` causes it to not be set, even if
|
||||
a value was inherited from another preset.
|
||||
|
||||
.. _`CMakePresets.testPresets.configurePreset`:
|
||||
|
||||
``configurePreset``
|
||||
An optional string specifying the name of a configure preset to
|
||||
associate with this test preset. If ``configurePreset`` is not
|
||||
specified, it must be inherited from the inherits preset (unless
|
||||
this preset is hidden). The build directory is inferred from the
|
||||
configure preset, so tests will run in the same ``binaryDir`` that
|
||||
the configuration and build used.
|
||||
|
||||
.. _`CMakePresets.testPresets.inheritConfigureEnvironment`:
|
||||
|
||||
``inheritConfigureEnvironment``
|
||||
An optional boolean that defaults to ``true``. If ``true``, the
|
||||
environment variables from the associated configure preset are
|
||||
inherited after all inherited test preset environments, but before
|
||||
environment variables explicitly specified in this test preset.
|
||||
|
||||
.. _`CMakePresets.testPresets.configuration`:
|
||||
|
||||
``configuration``
|
||||
An optional string. Equivalent to passing
|
||||
:ctest-option:`--build-config` on the command line.
|
||||
|
||||
.. _`CMakePresets.testPresets.overwriteConfigurationFile`:
|
||||
|
||||
``overwriteConfigurationFile``
|
||||
An optional array of configuration options to overwrite options
|
||||
specified in the CTest configuration file. Equivalent to passing
|
||||
:ctest-option:`--overwrite` for each value in the array. The array
|
||||
values support `macro expansion`_.
|
||||
|
||||
.. _`CMakePresets.testPresets.output`:
|
||||
|
||||
``output``
|
||||
An optional object specifying output options.
|
||||
The object may contain the following fields:
|
||||
|
||||
.. include:: presets/testOutput-properties.rst
|
||||
|
||||
.. _`CMakePresets.testPresets.filter`:
|
||||
|
||||
``filter``
|
||||
An optional object specifying how to filter the tests to run.
|
||||
The object may contain the following fields:
|
||||
|
||||
.. include:: presets/filter-properties.rst
|
||||
|
||||
.. _`CMakePresets.testPresets.execution`:
|
||||
|
||||
``execution``
|
||||
An optional object specifying options for test execution.
|
||||
The object may contain the following fields:
|
||||
|
||||
.. include:: presets/execution-properties.rst
|
||||
@@ -0,0 +1,27 @@
|
||||
.. This file was generated by Utilities/Scripts/regenerate-presets.py
|
||||
from Help/manual/presets/schema.yaml. Do not edit.
|
||||
|
||||
.. _`CMakePresets.configurePresets.toolset.value`:
|
||||
|
||||
``value``
|
||||
An optional string representing the value.
|
||||
|
||||
.. _`CMakePresets.configurePresets.toolset.strategy`:
|
||||
|
||||
``strategy``
|
||||
An optional string telling CMake how to handle the field.
|
||||
Valid values are:
|
||||
|
||||
``"set"``
|
||||
Set the respective value. This will result in an error for generators
|
||||
that do not support the respective field.
|
||||
|
||||
``"external"``
|
||||
Do not set the value, even if the generator supports it. This is
|
||||
useful if, for example, a preset uses the Ninja generator, and an IDE
|
||||
knows how to set up the Visual C++ environment from the architecture
|
||||
and toolset fields. In that case, CMake will 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"``.
|
||||
@@ -0,0 +1,53 @@
|
||||
.. This file was generated by Utilities/Scripts/regenerate-presets.py
|
||||
from Help/manual/presets/schema.yaml. Do not edit.
|
||||
|
||||
.. _`CMakePresets.configurePresets.trace.mode`:
|
||||
|
||||
``mode``
|
||||
An optional string that specifies the trace mode.
|
||||
Valid values are:
|
||||
|
||||
``on``
|
||||
Causes a trace of all calls made and from where to be
|
||||
printed. Equivalent to passing :cmake-option:`--trace`
|
||||
on the command line.
|
||||
|
||||
``off``
|
||||
A trace of all calls will not be printed.
|
||||
|
||||
``expand``
|
||||
Causes a trace with variables expanded of all calls made
|
||||
and from where to be printed. Equivalent to passing
|
||||
:cmake-option:`--trace-expand` on the command line.
|
||||
|
||||
.. _`CMakePresets.configurePresets.trace.format`:
|
||||
|
||||
``format``
|
||||
An optional string that specifies the format output of the
|
||||
trace. Valid values are:
|
||||
|
||||
``human``
|
||||
Prints each trace line in a human-readable format.
|
||||
This is the default format. Equivalent to passing
|
||||
:cmake-option:`--trace-format=human`
|
||||
on the command line.
|
||||
|
||||
``json-v1``
|
||||
Prints each line as a separate JSON document. Equivalent
|
||||
to passing :cmake-option:`--trace-format=json-v1`
|
||||
on the command line.
|
||||
|
||||
.. _`CMakePresets.configurePresets.trace.source`:
|
||||
|
||||
``source``
|
||||
An optional array of strings representing the paths of source
|
||||
files to be traced. This field can also be a string, which is
|
||||
equivalent to an array containing one string. Equivalent to
|
||||
passing :cmake-option:`--trace-source` on the command line.
|
||||
|
||||
.. _`CMakePresets.configurePresets.trace.redirect`:
|
||||
|
||||
``redirect``
|
||||
An optional string specifying a path to a trace output file.
|
||||
Equivalent to passing :cmake-option:`--trace-redirect` on the
|
||||
command line.
|
||||
@@ -0,0 +1,43 @@
|
||||
.. This file was generated by Utilities/Scripts/regenerate-presets.py
|
||||
from Help/manual/presets/schema.yaml. Do not edit.
|
||||
|
||||
.. _`CMakePresets.configurePresets.warnings.deprecated`:
|
||||
|
||||
``deprecated``
|
||||
An optional boolean. Equivalent to passing
|
||||
:cmake-option:`-Wdeprecated` or
|
||||
:cmake-option:`-Wno-deprecated`
|
||||
on the command line.
|
||||
This may not be set to ``false``
|
||||
if ``errors.deprecated`` is set to ``true``.
|
||||
|
||||
.. _`CMakePresets.configurePresets.warnings.dev`:
|
||||
|
||||
``dev``
|
||||
An optional boolean. Equivalent to passing
|
||||
:cmake-option:`-Wdev` or
|
||||
:cmake-option:`-Wno-dev`
|
||||
on the command line.
|
||||
This may not be set to ``false``
|
||||
if ``errors.dev`` is set to ``true``.
|
||||
|
||||
.. _`CMakePresets.configurePresets.warnings.uninitialized`:
|
||||
|
||||
``uninitialized``
|
||||
An optional boolean. Setting this to ``true`` is equivalent to
|
||||
passing :cmake-option:`--warn-uninitialized` on the command
|
||||
line.
|
||||
|
||||
.. _`CMakePresets.configurePresets.warnings.unusedCli`:
|
||||
|
||||
``unusedCli``
|
||||
An optional boolean. Setting this to ``false`` is equivalent to
|
||||
passing :cmake-option:`--no-warn-unused-cli` on the command
|
||||
line.
|
||||
|
||||
.. _`CMakePresets.configurePresets.warnings.systemVars`:
|
||||
|
||||
``systemVars``
|
||||
An optional boolean. Setting this to ``true`` is equivalent to
|
||||
passing :cmake-option:`--check-system-vars` on the command
|
||||
line.
|
||||
@@ -0,0 +1,44 @@
|
||||
.. This file was generated by Utilities/Scripts/regenerate-presets.py
|
||||
from Help/manual/presets/schema.yaml. Do not edit.
|
||||
|
||||
.. _`CMakePresets.workflowPresets.name`:
|
||||
|
||||
``name``
|
||||
A required string representing the machine-friendly name of the
|
||||
preset. This identifier is used in the
|
||||
:option:`cmake --workflow --preset <cmake--workflow --preset>`
|
||||
option. There must not be two workflow presets in the union of
|
||||
``CMakePresets.json`` and ``CMakeUserPresets.json`` in the same
|
||||
directory with the same name. However, a workflow preset may have
|
||||
the same name as a configure, build, test, or package preset.
|
||||
|
||||
.. _`CMakePresets.workflowPresets.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 if
|
||||
it does exist. However, it should follow the same conventions as the
|
||||
root-level ``vendor`` field. If vendors use their own per-preset
|
||||
``vendor`` field, they should implement inheritance in a sensible manner
|
||||
when appropriate.
|
||||
|
||||
.. _`CMakePresets.workflowPresets.displayName`:
|
||||
|
||||
``displayName``
|
||||
An optional string with a human-friendly name of the preset.
|
||||
|
||||
.. _`CMakePresets.workflowPresets.description`:
|
||||
|
||||
``description``
|
||||
An optional string with a human-friendly description of the preset.
|
||||
|
||||
.. _`CMakePresets.workflowPresets.steps`:
|
||||
|
||||
``steps``
|
||||
A required array of objects describing the steps of the workflow.
|
||||
The first step must be a configure preset, and all subsequent steps
|
||||
must be non-configure presets whose ``configurePreset`` field
|
||||
matches the starting configure preset. Each object may contain the
|
||||
following fields:
|
||||
|
||||
.. include:: presets/steps-properties.rst
|
||||
@@ -60,6 +60,6 @@ See Also
|
||||
|
||||
* The :option:`--install-prefix <cmake --install-prefix>` option.
|
||||
* The :genex:`$<INSTALL_PREFIX>` generator expression.
|
||||
* The :ref:`installDir <CMakePresets installDir>` field in CMake configure
|
||||
presets.
|
||||
* The :ref:`installDir <CMakePresets.configurePresets.installDir>` field in
|
||||
CMake configure presets.
|
||||
* The :variable:`CPACK_PACKAGING_INSTALL_PREFIX` variable.
|
||||
|
||||
Executable
+686
@@ -0,0 +1,686 @@
|
||||
#!/usr/bin/env python3
|
||||
"""Generate CMake presets documentation (reST) and JSON schema.
|
||||
|
||||
The documentation and JSON schema for CMake presets are both generated from
|
||||
Help/manual/presets/schema.yaml, which describes the schema in a way that
|
||||
allows both documentation forms to be combined in a single file, and also makes
|
||||
it much easier to manage version revisions (compared to editing the JSON schema
|
||||
'by hand').
|
||||
|
||||
All input and output files are expected to be in known locations relative to
|
||||
this script.
|
||||
|
||||
Usage: python3 regenerate-presets.py
|
||||
"""
|
||||
|
||||
import json
|
||||
from copy import deepcopy
|
||||
from pathlib import Path
|
||||
from typing import Any, Self
|
||||
|
||||
import yaml
|
||||
|
||||
LATEST = 1
|
||||
TYPES = {}
|
||||
REFS = {}
|
||||
|
||||
PRESETS_REL = 'Help/manual/presets'
|
||||
SCHEMA_YAML_FILENAME = 'schema.yaml'
|
||||
SCHEMA_JSON_FILENAME = 'schema.json'
|
||||
|
||||
WORKSPACE = Path(__file__).parent.parent.parent.absolute()
|
||||
PRESETS = WORKSPACE / PRESETS_REL
|
||||
|
||||
RST_BANNER = f"""\
|
||||
.. This file was generated by {Path(__file__).relative_to(WORKSPACE)}
|
||||
from {PRESETS_REL}/{SCHEMA_YAML_FILENAME}. Do not edit.
|
||||
"""
|
||||
|
||||
|
||||
# =============================================================================
|
||||
class Value:
|
||||
|
||||
# -------------------------------------------------------------------------
|
||||
def __init__(self, data: list[dict[str, Any]]):
|
||||
self.data = data
|
||||
self.spans = None
|
||||
|
||||
# -------------------------------------------------------------------------
|
||||
@property
|
||||
def objects(self) -> dict[str, 'Object']:
|
||||
return {}
|
||||
|
||||
# -------------------------------------------------------------------------
|
||||
def updateSpans(self, since: int, until: int) -> None:
|
||||
self.spans = [(since, until)]
|
||||
|
||||
# -------------------------------------------------------------------------
|
||||
def updateRefs(self, objects: dict[str, 'Object']) -> None:
|
||||
pass
|
||||
|
||||
# -------------------------------------------------------------------------
|
||||
def defs(self) -> dict[str, Any]:
|
||||
return {}
|
||||
|
||||
# -------------------------------------------------------------------------
|
||||
def schema(self, version: int) -> dict[str, Any]:
|
||||
return deepcopy(self.data)
|
||||
|
||||
|
||||
# =============================================================================
|
||||
class Object(Value):
|
||||
|
||||
# -------------------------------------------------------------------------
|
||||
def __init__(self, data: dict[str, Any], name: str,
|
||||
label: str | None = None):
|
||||
# Prevent data sharing from modifying unrelated parts of the schema as
|
||||
# we pick apart our section.
|
||||
data = deepcopy(data)
|
||||
|
||||
self.name = data.pop('id', name)
|
||||
self.label = label
|
||||
|
||||
self.properties = {}
|
||||
for n, p in data.pop('properties').items():
|
||||
pl = '.'.join([label, n]) if label is not None else n
|
||||
self.properties[n] = Property(p, n, pl)
|
||||
if len(self.properties):
|
||||
self.properties[CommentProperty.name] = CommentProperty()
|
||||
|
||||
ap = data.pop('additionalProperties', None)
|
||||
if ap is not None:
|
||||
self.additionalProperties = buildValue(ap, self.name, self.label)
|
||||
else:
|
||||
self.additionalProperties = None
|
||||
|
||||
super().__init__(data)
|
||||
|
||||
# -------------------------------------------------------------------------
|
||||
@property
|
||||
def objects(self) -> dict[str, Self]:
|
||||
out = {self.name: self}
|
||||
for p in self.properties.values():
|
||||
out.update(p.objects)
|
||||
if self.additionalProperties is not None:
|
||||
out.update(self.additionalProperties.objects)
|
||||
return out
|
||||
|
||||
# -------------------------------------------------------------------------
|
||||
def updateSpans(self, since: int, until: int) -> None:
|
||||
spans = [[(since, until)]]
|
||||
for p in self.properties.values():
|
||||
p.updateSpans(since, until)
|
||||
spans.append(p.spans)
|
||||
if self.additionalProperties is not None:
|
||||
self.additionalProperties.updateSpans(since, until)
|
||||
spans.append(self.additionalProperties.spans)
|
||||
self.spans = combineSpans(*spans)
|
||||
|
||||
# -------------------------------------------------------------------------
|
||||
def updateRefs(self, objects: dict[str, 'Object']) -> None:
|
||||
for p in self.properties.values():
|
||||
p.updateRefs(objects)
|
||||
if self.additionalProperties is not None:
|
||||
self.additionalProperties.updateRefs(objects)
|
||||
|
||||
# -------------------------------------------------------------------------
|
||||
def doc(self, since: int, until: int) -> str | None:
|
||||
since = max(since, self.spans[0][0])
|
||||
until = min(until, self.spans[-1][1])
|
||||
|
||||
out = []
|
||||
for _, p in self.properties.items():
|
||||
content = p.doc(since, until)
|
||||
if not content:
|
||||
continue
|
||||
out.append(content)
|
||||
|
||||
return '\n\n'.join(out) if len(out) else None
|
||||
|
||||
# -------------------------------------------------------------------------
|
||||
def defs(self, exclude: set[str] = {}) -> dict[str, Any]:
|
||||
out = {}
|
||||
for n, p in self.properties.items():
|
||||
if n in exclude:
|
||||
continue
|
||||
for s in p.spans:
|
||||
r = f'{p.label}@{spanRef(*s)}'
|
||||
out[r] = p.schema(s[0])
|
||||
out.update(p.defs())
|
||||
if self.additionalProperties is not None:
|
||||
out.update(self.additionalProperties.defs())
|
||||
return out
|
||||
|
||||
# -------------------------------------------------------------------------
|
||||
def schema(self, version: int, inline: set[str] = {}) -> dict[str, Any]:
|
||||
out = deepcopy(self.data)
|
||||
|
||||
props = {}
|
||||
required = []
|
||||
for n, p in self.properties.items():
|
||||
if n in inline:
|
||||
props[n] = p.schema(version)
|
||||
else:
|
||||
r = p.ref(version)
|
||||
if r is not None:
|
||||
props[n] = r
|
||||
if p.required:
|
||||
required.append(n)
|
||||
|
||||
out['properties'] = props
|
||||
if len(required):
|
||||
out['required'] = required
|
||||
|
||||
if self.additionalProperties is not None:
|
||||
ap = self.additionalProperties.schema(version)
|
||||
out['additionalProperties'] = ap
|
||||
return out
|
||||
|
||||
|
||||
# =============================================================================
|
||||
class Ref(Value):
|
||||
|
||||
# -------------------------------------------------------------------------
|
||||
def __init__(self, data: list[dict[str, Any]]):
|
||||
self.target = data.pop('target')
|
||||
self.targetSpans = None
|
||||
super().__init__(data)
|
||||
|
||||
# -------------------------------------------------------------------------
|
||||
def updateSpans(self, since: int, until: int) -> None:
|
||||
if self.spans is None:
|
||||
super().updateSpans(since, until)
|
||||
self.spans = trimSpans(self.spans, since, until)
|
||||
|
||||
# -------------------------------------------------------------------------
|
||||
def updateRefs(self, objects: dict[str, 'Object']) -> None:
|
||||
global REFS
|
||||
|
||||
t = objects.get(self.target)
|
||||
if t is not None:
|
||||
since = self.spans[0][0]
|
||||
until = self.spans[-1][1]
|
||||
self.spans = trimSpans(t.spans, since, until)
|
||||
self.targetSpans = t.spans
|
||||
|
||||
rs = REFS.get(self.target, (since, until))
|
||||
REFS[self.target] = (min(since, rs[0]), max(until, rs[1]))
|
||||
|
||||
# -------------------------------------------------------------------------
|
||||
def schema(self, version: int) -> dict[str, Any]:
|
||||
ts = trimSpans(self.targetSpans, *REFS[self.target])
|
||||
s = findSpan(ts, version)
|
||||
if s is not None:
|
||||
return {
|
||||
'$ref': f'#/definitions/{self.target}@{spanRef(*s)}',
|
||||
}
|
||||
return {}
|
||||
|
||||
|
||||
# =============================================================================
|
||||
class Array(Value):
|
||||
|
||||
# -------------------------------------------------------------------------
|
||||
def __init__(self, data: dict[str, Any], name: str, label: str):
|
||||
item = data.pop('items')
|
||||
self.value = buildValue(item, name, label)
|
||||
|
||||
super().__init__(data)
|
||||
|
||||
# -------------------------------------------------------------------------
|
||||
@property
|
||||
def objects(self) -> dict[str, Object]:
|
||||
return self.value.objects
|
||||
|
||||
# -------------------------------------------------------------------------
|
||||
def updateSpans(self, since: int, until: int) -> None:
|
||||
self.value.updateSpans(since, until)
|
||||
self.spans = self.value.spans
|
||||
|
||||
# -------------------------------------------------------------------------
|
||||
def updateRefs(self, objects: dict[str, 'Object']) -> None:
|
||||
self.value.updateRefs(objects)
|
||||
|
||||
# -------------------------------------------------------------------------
|
||||
def defs(self) -> dict[str, Any]:
|
||||
return self.value.defs()
|
||||
|
||||
# -------------------------------------------------------------------------
|
||||
def schema(self, version: int) -> dict[str, Any]:
|
||||
out = deepcopy(self.data)
|
||||
out['items'] = self.value.schema(version)
|
||||
return out
|
||||
|
||||
|
||||
# =============================================================================
|
||||
class Union(Value):
|
||||
|
||||
# -------------------------------------------------------------------------
|
||||
def __init__(self, data: list[dict[str, Any]], name: str, label: str):
|
||||
self.items = []
|
||||
for i, d in enumerate(data):
|
||||
self.items.append(buildValue(d, name, self.itemLabel(label, i)))
|
||||
|
||||
super().__init__({})
|
||||
|
||||
# -------------------------------------------------------------------------
|
||||
def itemLabel(self, label: str, index: int) -> str:
|
||||
return label
|
||||
|
||||
# -------------------------------------------------------------------------
|
||||
@property
|
||||
def objects(self) -> dict[str, Object]:
|
||||
out = {}
|
||||
for v in self.items:
|
||||
out.update(v.objects)
|
||||
return out
|
||||
|
||||
# -------------------------------------------------------------------------
|
||||
def updateSpans(self, since: int, until: int) -> None:
|
||||
spans = [[(since, until)]]
|
||||
for i in self.items:
|
||||
i.updateSpans(since, until)
|
||||
spans.append(i.spans)
|
||||
self.spans = combineSpans(*spans)
|
||||
|
||||
# -------------------------------------------------------------------------
|
||||
def updateRefs(self, objects: dict[str, 'Object']) -> None:
|
||||
for i in self.items:
|
||||
i.updateRefs(objects)
|
||||
|
||||
# -------------------------------------------------------------------------
|
||||
def defs(self) -> dict[str, Any]:
|
||||
out = {}
|
||||
for v in self.items:
|
||||
out.update(v.defs())
|
||||
return out
|
||||
|
||||
# -------------------------------------------------------------------------
|
||||
def schema(self, version: int) -> dict[str, Any]:
|
||||
out = []
|
||||
for i in self.items:
|
||||
out.append(i.schema(version))
|
||||
return {'anyOf': out}
|
||||
|
||||
|
||||
# =============================================================================
|
||||
class Variant(Union):
|
||||
|
||||
# -------------------------------------------------------------------------
|
||||
def __init__(self, data: list[dict[str, Any]], name: str, label: str):
|
||||
self.identifier = data.pop('id', None)
|
||||
|
||||
if self.identifier is not None:
|
||||
name = self.identifier
|
||||
label = self.identifier
|
||||
|
||||
super().__init__(data.pop('items'), name, label)
|
||||
|
||||
# -------------------------------------------------------------------------
|
||||
def itemLabel(self, label: str, index: int) -> str:
|
||||
return f'{label}[{index}]'
|
||||
|
||||
# -------------------------------------------------------------------------
|
||||
@property
|
||||
def objects(self) -> dict[str, Object]:
|
||||
out = super().objects
|
||||
if self.identifier is not None:
|
||||
out[self.identifier] = self
|
||||
return out
|
||||
|
||||
# -------------------------------------------------------------------------
|
||||
def doc(self, since: int, until: int) -> None:
|
||||
return None
|
||||
|
||||
# -------------------------------------------------------------------------
|
||||
def defs(self) -> dict[str, Any]:
|
||||
out = super().defs()
|
||||
|
||||
if self.identifier is not None:
|
||||
for s in self.spans:
|
||||
n = f'{self.identifier}@{spanRef(*s)}'
|
||||
out[n] = super().schema(s[0])
|
||||
|
||||
return out
|
||||
|
||||
# -------------------------------------------------------------------------
|
||||
def schema(self, version: int) -> dict[str, Any]:
|
||||
if self.identifier is not None:
|
||||
s = findSpan(self.spans, version)
|
||||
if s is not None:
|
||||
return {
|
||||
'$ref': f'#/definitions/{self.identifier}@{spanRef(*s)}',
|
||||
}
|
||||
return {}
|
||||
|
||||
return super().schema(version)
|
||||
|
||||
|
||||
# =============================================================================
|
||||
class Property:
|
||||
|
||||
# -------------------------------------------------------------------------
|
||||
def __init__(self, data: dict[str, Any], name: str, label: str):
|
||||
self.name = name
|
||||
self.label = label
|
||||
self.since = data.pop('since', 1)
|
||||
self.until = data.pop('until', LATEST + 1)
|
||||
self.required = data.pop('required', False)
|
||||
self.content = data.pop('sphinxDescription', data.get('description'))
|
||||
|
||||
note = data.pop('sphinxNote', None)
|
||||
if note is not None:
|
||||
self.content += f'\n\n.. note::\n\n{indent(note)}'
|
||||
|
||||
self._revisions = []
|
||||
for rev in data.pop('revisions', []):
|
||||
rd = deepcopy(data)
|
||||
rd.update(rev)
|
||||
self._revisions.append(Property(rd, self.name, self.label))
|
||||
|
||||
if len(self._revisions):
|
||||
self.since = max(self.since,
|
||||
min([r.since for r in self._revisions]))
|
||||
self.until = min(self.until,
|
||||
max([r.until for r in self._revisions]))
|
||||
self.value = None
|
||||
else:
|
||||
self.value = buildValue(data, self.name, self.label)
|
||||
|
||||
self.spans = None
|
||||
|
||||
# -------------------------------------------------------------------------
|
||||
@property
|
||||
def objects(self) -> dict[str, Object]:
|
||||
if len(self._revisions):
|
||||
out = {}
|
||||
for r in self._revisions:
|
||||
out.update(r.objects)
|
||||
return out
|
||||
|
||||
return self.value.objects
|
||||
|
||||
# -------------------------------------------------------------------------
|
||||
def updateSpans(self, since: int, until: int) -> None:
|
||||
since = max(since, self.since)
|
||||
until = min(until, self.until)
|
||||
|
||||
if len(self._revisions):
|
||||
spans = [[(since, until)]]
|
||||
for r in self._revisions:
|
||||
r.updateSpans(since, until)
|
||||
spans.append(r.spans)
|
||||
self.spans = combineSpans(*spans)
|
||||
else:
|
||||
self.value.updateSpans(since, until)
|
||||
self.spans = self.value.spans
|
||||
|
||||
# -------------------------------------------------------------------------
|
||||
def updateRefs(self, objects: dict[str, 'Object']) -> None:
|
||||
if len(self._revisions):
|
||||
for r in self._revisions:
|
||||
r.updateRefs(objects)
|
||||
else:
|
||||
self.value.updateRefs(objects)
|
||||
|
||||
# -------------------------------------------------------------------------
|
||||
def ref(self, version: int) -> dict[str, str] | None:
|
||||
s = findSpan(self.spans, version)
|
||||
if s is not None:
|
||||
return {
|
||||
'$ref': f'#/definitions/{self.label}@{spanRef(*s)}',
|
||||
}
|
||||
return None
|
||||
|
||||
# -------------------------------------------------------------------------
|
||||
def doc(self, since: int, until: int) -> str | None:
|
||||
if self.content is None:
|
||||
return None
|
||||
|
||||
out = f'.. _`CMakePresets.{self.label}`:\n\n``{self.name}``\n'
|
||||
if self.since > since:
|
||||
out += f' .. presets-versionadded:: {self.since}\n\n'
|
||||
if self.until < until:
|
||||
out += f' .. presets-versionremoved:: {self.until}\n\n'
|
||||
out += indent(self.content)
|
||||
|
||||
return out
|
||||
|
||||
# -------------------------------------------------------------------------
|
||||
def defs(self) -> dict[str, Any]:
|
||||
if len(self._revisions):
|
||||
out = {}
|
||||
for r in self._revisions:
|
||||
out.update(r.defs())
|
||||
return out
|
||||
|
||||
return self.value.defs()
|
||||
|
||||
# -------------------------------------------------------------------------
|
||||
def schema(self, version: int) -> dict[str, Any]:
|
||||
for r in self._revisions:
|
||||
if version >= r.since and version < r.until:
|
||||
return r.value.schema(version)
|
||||
return self.value.schema(version)
|
||||
|
||||
|
||||
# =============================================================================
|
||||
class CommentProperty(Property):
|
||||
name: str = '$comment'
|
||||
since: int = 10
|
||||
|
||||
# -------------------------------------------------------------------------
|
||||
def __init__(self):
|
||||
data = {
|
||||
'since': type(self).since,
|
||||
'id': 'comment',
|
||||
'type': 'variant',
|
||||
'items': [
|
||||
{
|
||||
'type': 'string',
|
||||
'description': 'A single-line comment.',
|
||||
},
|
||||
{
|
||||
'type': 'array',
|
||||
'description': 'A multi-line comment.',
|
||||
'minItems': 1,
|
||||
'items': {
|
||||
'type': 'string',
|
||||
'description': 'One line of the multi-line comment.',
|
||||
}
|
||||
}
|
||||
],
|
||||
}
|
||||
super().__init__(data, type(self).name, type(self).name)
|
||||
|
||||
# -------------------------------------------------------------------------
|
||||
def doc(self, since: int, until: int) -> None:
|
||||
return None
|
||||
|
||||
|
||||
# -----------------------------------------------------------------------------
|
||||
def buildValue(
|
||||
data: Any, name: str, label: str | None = None
|
||||
) -> Variant | Object | Array | Ref | Value:
|
||||
if type(data) is dict:
|
||||
if 'anyOf' in data:
|
||||
return Union(data.pop('anyOf'), name, label)
|
||||
elif data['type'] == 'variant':
|
||||
return Variant(data, name, label)
|
||||
elif data['type'] == 'array':
|
||||
return Array(data, name, label)
|
||||
elif data['type'] == 'object':
|
||||
return Object(data, name, label)
|
||||
elif data['type'] == 'ref':
|
||||
return Ref(data)
|
||||
|
||||
return Value(data)
|
||||
|
||||
|
||||
# -----------------------------------------------------------------------------
|
||||
def extractDivisions(spans: list[tuple[int, int]]) -> set[int]:
|
||||
return {n for s in spans for n in s}
|
||||
|
||||
|
||||
# -----------------------------------------------------------------------------
|
||||
def trimSpans(spans: list[tuple[int, int]],
|
||||
since: int, until: int) -> list[tuple[int, int]]:
|
||||
divisions = extractDivisions(spans)
|
||||
|
||||
last = since
|
||||
out = []
|
||||
|
||||
for d in sorted(divisions):
|
||||
if d > since:
|
||||
out.append((last, min(d, until)))
|
||||
last = min(d, until)
|
||||
if d >= until:
|
||||
break
|
||||
|
||||
return out
|
||||
|
||||
|
||||
# -----------------------------------------------------------------------------
|
||||
def combineSpans(*spans: list[tuple[int, int]]) -> list[tuple[int, int]]:
|
||||
divisions = set()
|
||||
for s in spans:
|
||||
divisions.update(extractDivisions(s))
|
||||
|
||||
divisions = sorted(divisions)
|
||||
last = divisions.pop(0)
|
||||
out = []
|
||||
|
||||
for d in divisions:
|
||||
out.append((last, d))
|
||||
last = d
|
||||
|
||||
return out
|
||||
|
||||
|
||||
# -----------------------------------------------------------------------------
|
||||
def findSpan(spans: list[tuple[int, int]],
|
||||
version: int) -> tuple[int, int] | None:
|
||||
for s in spans:
|
||||
if version >= s[0] and version < s[1]:
|
||||
return s
|
||||
|
||||
return None
|
||||
|
||||
|
||||
# -----------------------------------------------------------------------------
|
||||
def spanRef(since: int, until: int) -> str:
|
||||
if since + 1 < until:
|
||||
if until > LATEST:
|
||||
return f'v{since}..'
|
||||
else:
|
||||
return f'v{since}..v{until - 1}'
|
||||
return f'v{since}'
|
||||
|
||||
|
||||
# -----------------------------------------------------------------------------
|
||||
def indent(text: str):
|
||||
return '\n'.join([(' ' + line).rstrip() for line in text.split('\n')])
|
||||
|
||||
|
||||
# -----------------------------------------------------------------------------
|
||||
def trimDescriptions(data: Any):
|
||||
if type(data) is dict:
|
||||
for k, v in data.items():
|
||||
if type(v) is str and k in {'description', 'sphinxDescription'}:
|
||||
data[k] = v.strip()
|
||||
elif type(v) is dict:
|
||||
data[k] = trimDescriptions(v)
|
||||
elif type(v) is list:
|
||||
data[k] = [trimDescriptions(item) for item in v]
|
||||
|
||||
return data
|
||||
|
||||
|
||||
# -----------------------------------------------------------------------------
|
||||
def main():
|
||||
# Read the schema definition.
|
||||
with open(PRESETS / SCHEMA_YAML_FILENAME, 'r') as f:
|
||||
schema = yaml.safe_load(f)
|
||||
|
||||
# Extract the current (latest) version.
|
||||
global LATEST
|
||||
|
||||
del schema['definitions']
|
||||
LATEST = schema.pop('version')
|
||||
|
||||
# Remove whitespace around descriptions.
|
||||
schema = trimDescriptions(schema)
|
||||
|
||||
# Extract global type definitions.
|
||||
global TYPES, REFS
|
||||
|
||||
for t in schema.pop('types', []):
|
||||
name = t['id']
|
||||
value = buildValue(t, name)
|
||||
value.updateSpans(1, LATEST + 1)
|
||||
TYPES[name] = value
|
||||
|
||||
for t in TYPES.values():
|
||||
t.updateRefs(TYPES)
|
||||
|
||||
# Reset the spans for references, as these currently contain only spans for
|
||||
# circular references of global types, which are likely broader than the
|
||||
# actual usage spans of those types. We'll recalculate the correct spans
|
||||
# when we update refs from the root object.
|
||||
REFS = {}
|
||||
|
||||
# Parse the root object. This will also recursively parse other objects.
|
||||
root = Object(schema, 'root')
|
||||
root.updateSpans(1, LATEST + 1)
|
||||
|
||||
# Resolve references.
|
||||
objects = root.objects
|
||||
|
||||
types = objects
|
||||
types.update(TYPES)
|
||||
|
||||
root.updateRefs(types)
|
||||
|
||||
for name, value in TYPES.items():
|
||||
span = REFS.get(name)
|
||||
if span is not None:
|
||||
value.updateSpans(*span)
|
||||
|
||||
root.updateSpans(1, LATEST + 1)
|
||||
|
||||
# Extract Sphinx documentation for each object's properties.
|
||||
for n, o in objects.items():
|
||||
doc = o.doc(1, LATEST + 1)
|
||||
if doc is not None:
|
||||
print(f'- Generating reST documentation for {n} properties')
|
||||
with open(PRESETS / f'{o.name}-properties.rst', 'w') as f:
|
||||
print(RST_BANNER, file=f)
|
||||
print(doc, file=f)
|
||||
|
||||
# Generate schema for each version.
|
||||
versions = []
|
||||
for v in range(1, LATEST + 1):
|
||||
vs = root.schema(v, inline={'version'})
|
||||
vs['properties']['version']['const'] = v
|
||||
versions.append(vs)
|
||||
|
||||
# Add definitions and write the schema.
|
||||
types = root.defs(exclude={'version'})
|
||||
for t in TYPES.values():
|
||||
types.update(t.defs())
|
||||
|
||||
schema = {
|
||||
'$schema': 'http://json-schema.org/draft/2020-12/schema#',
|
||||
'type': 'object',
|
||||
'oneOf': versions,
|
||||
'required': ['version'],
|
||||
'definitions': types
|
||||
}
|
||||
|
||||
with open(PRESETS / SCHEMA_JSON_FILENAME, 'w') as f:
|
||||
print(json.dumps(schema, indent=2), file=f)
|
||||
|
||||
|
||||
# %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
||||
|
||||
main()
|
||||
@@ -21,6 +21,8 @@ if sphinx.version_info >= (2,):
|
||||
from sphinx import addnodes
|
||||
from sphinx.directives import ObjectDescription, nl_escape_re
|
||||
from sphinx.domains import Domain, ObjType
|
||||
from sphinx.domains.changeset import VersionChange
|
||||
from sphinx.domains.changeset import versionlabels, versionlabel_classes
|
||||
from sphinx.domains.std import OptionXRefRole
|
||||
from sphinx.roles import XRefRole
|
||||
from sphinx.util import logging, ws_re
|
||||
@@ -776,4 +778,21 @@ def setup(app):
|
||||
app.add_transform(CMakeTransform)
|
||||
app.add_transform(CMakeXRefTransform)
|
||||
app.add_domain(CMakeDomain)
|
||||
|
||||
versionlabels.update({
|
||||
'presets-versionadded': 'Added in presets version %s',
|
||||
'presets-versionchanged': 'Changed in presets version %s',
|
||||
'presets-versionremoved': 'Removed in presets version %s',
|
||||
})
|
||||
|
||||
versionlabel_classes.update({
|
||||
'presets-versionadded': 'added',
|
||||
'presets-versionchanged': 'changed',
|
||||
'presets-versionremoved': 'removed',
|
||||
})
|
||||
|
||||
app.add_directive('presets-versionadded', VersionChange)
|
||||
app.add_directive('presets-versionchanged', VersionChange)
|
||||
app.add_directive('presets-versionremoved', VersionChange)
|
||||
|
||||
return {"parallel_read_safe": True}
|
||||
|
||||
@@ -26,7 +26,8 @@ exclude_patterns = [
|
||||
'dev',
|
||||
# NOTE Ignore shared RST files used in `.. include::` directives
|
||||
'include/*.rst',
|
||||
'**/include/*.rst'
|
||||
'**/include/*.rst',
|
||||
'manual/presets/*.rst',
|
||||
]
|
||||
|
||||
extensions = ['cmake']
|
||||
|
||||
Reference in New Issue
Block a user