Help/presets: Use preset role for configurePreset references
diff --git a/Help/manual/cmake.1.rst b/Help/manual/cmake.1.rst index 75d9f33..de24ccb 100644 --- a/Help/manual/cmake.1.rst +++ b/Help/manual/cmake.1.rst
@@ -795,8 +795,9 @@ .. option:: --preset <preset>, --preset=<preset> Use a build :manual:`preset <cmake-presets(7)>` to specify build options. - The project binary directory is inferred from the ``configurePreset`` key - unless a directory is specified after ``--build``. + The project binary directory is inferred from the + :preset:`buildPresets.configurePreset` key unless a directory is specified + after ``--build``. .. versionadded:: 4.3 ``cmake --build`` now supports specifying a build directory and
diff --git a/Help/manual/cpack.1.rst b/Help/manual/cpack.1.rst index cb9d7a3..c0fe0cc 100644 --- a/Help/manual/cpack.1.rst +++ b/Help/manual/cpack.1.rst
@@ -124,8 +124,8 @@ Use a package :manual:`preset <cmake-presets(7)>` to specify package options. The project binary directory is inferred from the - ``configurePreset`` key. The current working directory must contain - ``CMakePresets.json`` or ``CMakeUserPresets.json``. + :preset:`packagePresets.configurePreset` key. The current working directory + must contain ``CMakePresets.json`` or ``CMakeUserPresets.json``. .. option:: --list-presets
diff --git a/Help/manual/ctest.1.rst b/Help/manual/ctest.1.rst index 2fa7724..0d98bf4 100644 --- a/Help/manual/ctest.1.rst +++ b/Help/manual/ctest.1.rst
@@ -70,14 +70,14 @@ .. option:: --preset <preset>, --preset=<preset> Use a test :manual:`preset <cmake-presets(7)>` to specify test options. The - project binary directory is inferred from the ``configurePreset`` key. The - current working directory must contain ``CMakePresets.json`` and/or - ``CMakeUserPresets.json``. + project binary directory is inferred from the + :preset:`testPresets.configurePreset` key. The current working directory must + contain ``CMakePresets.json`` and/or ``CMakeUserPresets.json``. .. versionadded:: 3.30 - The ``--test-dir`` option may optionally be specified with a different - binary directory than the one specified by the ``configurePreset`` key - of the test preset. + The :ctest-option:`--test-dir` option may be specified with a different + binary directory than the one specified by the + :preset:`testPresets.configurePreset` key. .. option:: --list-presets
diff --git a/Help/manual/presets/buildPresets-properties.rst b/Help/manual/presets/buildPresets-properties.rst index e2c0169..1256280 100644 --- a/Help/manual/presets/buildPresets-properties.rst +++ b/Help/manual/presets/buildPresets-properties.rst
@@ -18,9 +18,10 @@ 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. + valid :preset:`buildPresets.configurePreset`, even from + inheritance. ``hidden`` presets are intended to be used as a base + for other presets to inherit via the + :preset:`buildPresets.inherits` field. .. _`CMakePresets.buildPresets.inherits`:
diff --git a/Help/manual/presets/packagePresets-properties.rst b/Help/manual/presets/packagePresets-properties.rst index 2c21b53..863500f 100644 --- a/Help/manual/presets/packagePresets-properties.rst +++ b/Help/manual/presets/packagePresets-properties.rst
@@ -17,9 +17,10 @@ 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. + :preset:`packagePresets.configurePreset`, even from + inheritance. ``hidden`` presets are intended to be used as a base + for other presets to inherit via the + :preset:`packagePresets.inherits` field. .. _`CMakePresets.packagePresets.inherits`:
diff --git a/Help/manual/presets/schema.yaml b/Help/manual/presets/schema.yaml index 22784f3..c66bab0 100644 --- a/Help/manual/presets/schema.yaml +++ b/Help/manual/presets/schema.yaml
@@ -963,9 +963,10 @@ 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. + valid :preset:`buildPresets.configurePreset`, even from + inheritance. ``hidden`` presets are intended to be used as a base + for other presets to inherit via the + :preset:`buildPresets.inherits` field. inherits: *preset-inherits condition: *condition vendor: *preset-vendor @@ -1181,9 +1182,10 @@ 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. + :preset:`testPresets.configurePreset`, even from + inheritance. ``hidden`` presets are intended to be used as a base + for other presets to inherit via the + :preset:`testPresets.inherits` field. inherits: *preset-inherits condition: *condition vendor: *preset-vendor @@ -1819,9 +1821,10 @@ 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. + :preset:`packagePresets.configurePreset`, even from + inheritance. ``hidden`` presets are intended to be used as a base + for other presets to inherit via the + :preset:`packagePresets.inherits` field. inherits: *preset-inherits condition: *condition vendor: *preset-vendor
diff --git a/Help/manual/presets/testPresets-properties.rst b/Help/manual/presets/testPresets-properties.rst index 293d88f..6e71ab4 100644 --- a/Help/manual/presets/testPresets-properties.rst +++ b/Help/manual/presets/testPresets-properties.rst
@@ -17,9 +17,10 @@ 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. + :preset:`testPresets.configurePreset`, even from + inheritance. ``hidden`` presets are intended to be used as a base + for other presets to inherit via the + :preset:`testPresets.inherits` field. .. _`CMakePresets.testPresets.inherits`: