From b00512e6929c046ff472563cf1d0407149c51bb7 Mon Sep 17 00:00:00 2001 From: Michael Hirsch Date: Tue, 8 Jun 2021 10:46:16 -0400 Subject: [PATCH] Help: presets: add note for ExternalProject users with env vars 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. --- Help/manual/cmake-presets.7.rst | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/Help/manual/cmake-presets.7.rst b/Help/manual/cmake-presets.7.rst index 0bcd6910ad..db26b5a40f 100644 --- a/Help/manual/cmake-presets.7.rst +++ b/Help/manual/cmake-presets.7.rst @@ -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