1
0
mirror of https://github.com/Kitware/CMake.git synced 2025-10-15 03:48:02 +08:00

Help: Link to tool-specific preset arguments from cmake-presets(7)

Fixes: #21835
This commit is contained in:
Brad King
2021-02-18 10:31:34 -05:00
parent dd6165fbd4
commit 0e3c361f77
2 changed files with 9 additions and 6 deletions

View File

@@ -91,8 +91,8 @@ that may contain the following fields:
``name``
A required string representing the machine-friendly name of the preset.
This identifier is used in the ``--preset`` argument. There must not be
two presets in the union of ``CMakePresets.json`` and
This identifier is used in the :ref:`cmake --preset <CMake Options>` option.
There must not be two presets in the union of ``CMakePresets.json`` and
``CMakeUserPresets.json`` in the same directory with the same name.
``hidden``
@@ -309,8 +309,9 @@ that may contain the following fields:
``name``
A required string representing the machine-friendly name of the preset.
This identifier is used in the ``--preset`` argument. There must not be
two presets (configure, build, or test) in the union of
This identifier is used in the
:ref:`cmake --build --preset <Build Tool Mode>` option.
There must not be two presets (configure, build, or test) in the union of
``CMakePresets.json`` and ``CMakeUserPresets.json`` in the same
directory with the same name.
@@ -427,8 +428,8 @@ that may contain the following fields:
``name``
A required string representing the machine-friendly name of the preset.
This identifier is used in the ``--preset`` argument. There must not be
two presets (configure, build, or test) in the union of
This identifier is used in the :ref:`ctest --preset <CTest Options>` option.
There must not be two presets (configure, build, or test) in the union of
``CMakePresets.json`` and ``CMakeUserPresets.json`` in the same
directory with the same name.

View File

@@ -25,6 +25,8 @@ CMake-generated build trees created for projects that use the
:command:`enable_testing` and :command:`add_test` commands have testing support.
This program will run the tests and report results.
.. _`CTest Options`:
Options
=======