summaryrefslogtreecommitdiff
path: root/Modules
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2021-11-30 13:46:00 +0000
committerKitware Robot <kwrobot@kitware.com>2021-11-30 08:46:11 -0500
commit5109a22d61ebe42c2e36a2fbd35114b22334fa76 (patch)
treebf0bc66a4788c20e3c691f0b076cf0616b0674f4 /Modules
parentee2a3254ee454329d9eeca028d4a355dc5328723 (diff)
parent3caeee0c86f4bf1922892734a8b3310a34e9bd90 (diff)
downloadcmake-5109a22d61ebe42c2e36a2fbd35114b22334fa76.tar.gz
Merge topic 'doc-CMAKE_INSTALL_MODE' into release-3.22
3caeee0c86 Help: Clarify CMAKE_INSTALL_MODE documentation 699d4a98e2 Help: Use definition list for allowed values of CMAKE_INSTALL_MODE Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !6743
Diffstat (limited to 'Modules')
-rw-r--r--Modules/ExternalProject.cmake16
1 files changed, 16 insertions, 0 deletions
diff --git a/Modules/ExternalProject.cmake b/Modules/ExternalProject.cmake
index e49faae183..4004ea443e 100644
--- a/Modules/ExternalProject.cmake
+++ b/Modules/ExternalProject.cmake
@@ -637,6 +637,22 @@ External Project Definition
supported). Passing an empty string as the ``<cmd>`` makes the install
step do nothing.
+ .. note::
+ If the :envvar:`CMAKE_INSTALL_MODE` environment variable is set when the
+ main project is built, it will only have an effect if the following
+ conditions are met:
+
+ * The main project's configure step assumed the external project uses
+ CMake as its build system.
+ * The external project's install command actually runs. Note that due
+ to the way ``ExternalProject`` may use timestamps internally, if
+ nothing the install step depends on needs to be re-executed, the
+ install command might also not need to run.
+
+ Note also that ``ExternalProject`` does not check whether the
+ :envvar:`CMAKE_INSTALL_MODE` environment variable changes from one run
+ to another.
+
**Test Step Options:**
The test step is only defined if at least one of the following ``TEST_...``
options are provided.