diff options
author | Felix Lelchuk <felix.lelchuk@gmx.de> | 2021-11-18 03:01:10 (GMT) |
---|---|---|
committer | Craig Scott <craig.scott@crascit.com> | 2021-11-23 21:30:38 (GMT) |
commit | 3caeee0c86f4bf1922892734a8b3310a34e9bd90 (patch) | |
tree | 7a3d284e2a56446e55d2d754cab9dc0745d1a392 /Modules/ExternalProject.cmake | |
parent | 699d4a98e291b48f54b5a1996cda69b78e7c7d4f (diff) | |
download | CMake-3caeee0c86f4bf1922892734a8b3310a34e9bd90.zip CMake-3caeee0c86f4bf1922892734a8b3310a34e9bd90.tar.gz CMake-3caeee0c86f4bf1922892734a8b3310a34e9bd90.tar.bz2 |
Help: Clarify CMAKE_INSTALL_MODE documentation
Fixes: #22869
Co-Authored-By: Craig Scott <craig.scott@crascit.com>
Diffstat (limited to 'Modules/ExternalProject.cmake')
-rw-r--r-- | Modules/ExternalProject.cmake | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/Modules/ExternalProject.cmake b/Modules/ExternalProject.cmake index e49faae..4004ea4 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. |