summaryrefslogtreecommitdiffstats
path: root/Modules
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2017-02-22 15:15:29 (GMT)
committerCMake Topic Stage <kwrobot@kitware.com>2017-02-22 15:15:29 (GMT)
commit8aac0ae7c52c6f1937f6192620933f546574c730 (patch)
treedc713f846b658a849cb4d9522806d131eeed210b /Modules
parent28df39ca8efbd3380e81977954aeda93ce53db10 (diff)
parentc95d017f9c221f309a4b74d8a033c1e99e784f90 (diff)
downloadCMake-8aac0ae7c52c6f1937f6192620933f546574c730.zip
CMake-8aac0ae7c52c6f1937f6192620933f546574c730.tar.gz
CMake-8aac0ae7c52c6f1937f6192620933f546574c730.tar.bz2
Merge topic 'ExternalProject-update-docs'
c95d017f ExternalProject: Clarify documented role of `INSTALL_DIR` 4b21290e ExternalProject: Clarify documented role of `INSTALL_COMMAND`
Diffstat (limited to 'Modules')
-rw-r--r--Modules/ExternalProject.cmake11
1 files changed, 9 insertions, 2 deletions
diff --git a/Modules/ExternalProject.cmake b/Modules/ExternalProject.cmake
index 458c114..c3fd3c6 100644
--- a/Modules/ExternalProject.cmake
+++ b/Modules/ExternalProject.cmake
@@ -174,9 +174,16 @@ 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 install after build
+ Command to drive installation of the external project after it has been
+ built. This only happens at the *build* time of the calling project.
+ In order to install files from the external project alongside the
+ locally-built files, a separate local :command:`install` call must be
+ added to pick the files up from one of the external project trees.
Test step options are: