diff options
| author | Cristian Le <cristian.le@mpsd.mpg.de> | 2024-06-06 07:37:43 (GMT) |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2024-06-06 12:51:16 (GMT) |
| commit | 1ea780ea7ca6fa9eda471af14533eec38476b4a7 (patch) | |
| tree | 254be9bd6478c83bc4f26009c187766eb50a9f5a /Help | |
| parent | c370593f2e41b2094d6d7f1a1c47cd5d9d371388 (diff) | |
| download | CMake-1ea780ea7ca6fa9eda471af14533eec38476b4a7.zip CMake-1ea780ea7ca6fa9eda471af14533eec38476b4a7.tar.gz CMake-1ea780ea7ca6fa9eda471af14533eec38476b4a7.tar.bz2 | |
Help: Clarify preset-specific macros
Closes: #26030
Signed-off-by: Cristian Le <cristian.le@mpsd.mpg.de>
Diffstat (limited to 'Help')
| -rw-r--r-- | Help/manual/cmake-presets.7.rst | 9 | ||||
| -rw-r--r-- | Help/release/3.30.rst | 3 |
2 files changed, 9 insertions, 3 deletions
diff --git a/Help/manual/cmake-presets.7.rst b/Help/manual/cmake-presets.7.rst index 5e91ae5..59b34c6 100644 --- a/Help/manual/cmake-presets.7.rst +++ b/Help/manual/cmake-presets.7.rst @@ -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 diff --git a/Help/release/3.30.rst b/Help/release/3.30.rst index a9273b6..8c8bb85 100644 --- a/Help/release/3.30.rst +++ b/Help/release/3.30.rst @@ -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 -------------- |