.. 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.