summaryrefslogtreecommitdiffstats
path: root/Modules
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2017-02-21 15:31:24 (GMT)
committerBrad King <brad.king@kitware.com>2017-02-21 15:32:26 (GMT)
commitc95d017f9c221f309a4b74d8a033c1e99e784f90 (patch)
treeacc215397f92d7f53c0733b880eacaa8383c07ac /Modules
parent4b21290e204d02dd39f6ac404ba923d546f40925 (diff)
downloadCMake-c95d017f9c221f309a4b74d8a033c1e99e784f90.zip
CMake-c95d017f9c221f309a4b74d8a033c1e99e784f90.tar.gz
CMake-c95d017f9c221f309a4b74d8a033c1e99e784f90.tar.bz2
ExternalProject: Clarify documented role of `INSTALL_DIR`
It does not actually configure the project to install to the given location. That must be done by passing the `<INSTALL_DIR>` placeholder to the external project configuration step.
Diffstat (limited to 'Modules')
-rw-r--r--Modules/ExternalProject.cmake5
1 files changed, 4 insertions, 1 deletions
diff --git a/Modules/ExternalProject.cmake b/Modules/ExternalProject.cmake
index 325fbc3..c3fd3c6 100644
--- a/Modules/ExternalProject.cmake
+++ b/Modules/ExternalProject.cmake
@@ -174,7 +174,10 @@ Create custom targets to build projects in external trees
Install step options are:
``INSTALL_DIR <dir>``
- Installation prefix
+ Installation prefix to be placed in the ``<INSTALL_DIR>`` placeholder.
+ This does not actually configure the external project to install to
+ the given prefix. That must be done by passing appropriate arguments
+ to the external project configuration step, e.g. using ``<INSTALL_DIR>``.
``INSTALL_COMMAND <cmd>...``
Command to drive installation of the external project after it has been
built. This only happens at the *build* time of the calling project.