diff options
| author | Brad King <brad.king@kitware.com> | 2017-02-22 15:15:29 (GMT) |
|---|---|---|
| committer | CMake Topic Stage <kwrobot@kitware.com> | 2017-02-22 15:15:29 (GMT) |
| commit | 8aac0ae7c52c6f1937f6192620933f546574c730 (patch) | |
| tree | dc713f846b658a849cb4d9522806d131eeed210b | |
| parent | 28df39ca8efbd3380e81977954aeda93ce53db10 (diff) | |
| parent | c95d017f9c221f309a4b74d8a033c1e99e784f90 (diff) | |
| download | CMake-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`
| -rw-r--r-- | Modules/ExternalProject.cmake | 11 |
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: |