diff options
| author | Michael Hirsch <scivision@users.noreply.gitlab.kitware.com> | 2021-02-18 04:14:49 (GMT) |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2021-02-18 19:53:28 (GMT) |
| commit | 3f8cf006cb2c32ef70a5257e3402350b33796302 (patch) | |
| tree | 07c61a5b354a6fdb9740d40b42c19d92a4d4302e /Help | |
| parent | 98ae005137cb52a01612371f6d16e456aa1342fe (diff) | |
| download | CMake-3f8cf006cb2c32ef70a5257e3402350b33796302.zip CMake-3f8cf006cb2c32ef70a5257e3402350b33796302.tar.gz CMake-3f8cf006cb2c32ef70a5257e3402350b33796302.tar.bz2 | |
Help: Clarify preset name conflict rules in cmake-presets(7)
Diffstat (limited to 'Help')
| -rw-r--r-- | Help/manual/cmake-presets.7.rst | 17 |
1 files changed, 9 insertions, 8 deletions
diff --git a/Help/manual/cmake-presets.7.rst b/Help/manual/cmake-presets.7.rst index ac3ecf5..55a9947 100644 --- a/Help/manual/cmake-presets.7.rst +++ b/Help/manual/cmake-presets.7.rst @@ -95,8 +95,9 @@ that may contain the following fields: A required string representing the machine-friendly name of the preset. 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. + 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 or test preset. ``hidden`` @@ -314,9 +315,9 @@ that may contain the following fields: A required string representing the machine-friendly name of the preset. 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. + 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 or test preset. ``hidden`` @@ -433,9 +434,9 @@ that may contain the following fields: A required string representing the machine-friendly name of the preset. 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. + 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 or build preset. ``hidden`` |