mirror/CMake
1
0
Fork 0
mirror of https://github.com/Kitware/CMake.git synced 2026-01-10 07:40:03 -06:00
Code Issues Packages Projects Releases Wiki Activity

Merge topic 'doc-preset-specific-macros'

Browse Source 
1ea780ea7c Help: Clarify preset-specific macros

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !9587
This commit is contained in:
Brad King
2024-06-06 13:36:31 +00:00
committed by Kitware Robot
parent f795b909fd 1ea780ea7c
commit bf645e0577
2 changed files with 9 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
Help/manual/cmake-presets.7.rst
View File

@@ -150,8 +150,9 @@ 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 preset specific
ones (e.g. ``presetName``), and ``$env{}``.
``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``.
Configure Preset
^^^^^^^^^^^^^^^^
@@ -1217,11 +1218,15 @@ Recognized macros include:
``${presetName}``
Name specified in the preset's ``name`` field.
This is a preset-specific macro.
``${generator}``
Generator specified in the preset's ``generator`` field. For build and
test presets, this will evaluate to the generator specified by
``configurePreset``.
This is a preset-specific macro.
``${hostSystemName}``
The name of the host operating system. Contains the same value as
:variable:`CMAKE_HOST_SYSTEM_NAME`. This is allowed in preset files

3
Help/release/3.30.rst
View File

@@ -15,7 +15,8 @@ Presets
* :manual:`cmake-presets(7)` files now support schema version ``9``.
``include`` fields now expand all macros except ``$env{}`` and
preset-specific macros.
preset-specific macros, i.e., those derived from the fields
inside a preset's definition.
File-Based API
--------------