Kitware/CMake
1
0
Fork 0
mirror of https://github.com/Kitware/CMake.git synced 2025-10-15 20:46:37 +08:00
Code Issues Projects Releases Wiki Activity

Help: presets: add note for ExternalProject users with env vars

Browse Source 
Although this behavior is implied in the existing help text, I think
this use case is common and could be puzzling to those who do not
thoroughly read the existing help text. I think that warrants
a "Note:" on this page.
This commit is contained in:
Michael Hirsch
2021-06-08 10:46:16 -04:00
committed by Brad King
parent acb25d50d9
commit b00512e692
1 changed files with 13 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -401,6 +401,19 @@ that may contain the following fields:
are applied. Setting a variable to ``null`` causes it to not be set,
even if a value was inherited from another preset.
.. note::
For a CMake project using ExternalProject with a configuration preset
having environment variables needed in the ExternalProject, use a build
preset that inherits that configuration preset or the ExternalProject
will not have the environment variables set in the configuration preset.
Example: suppose the host defaults to one compiler (say Clang)
and the user wishes to use another compiler (say GCC). Set configuration
preset environment variables ``CC`` and ``CXX`` and use a build preset
that inherits that configuration preset. Otherwise the ExternalProject
may use a different (system default) compiler than the top-level CMake
project.
``configurePreset``
An optional string specifying the name of a configure preset to