diff options
| author | Brad King <brad.king@kitware.com> | 2017-02-21 10:31:24 -0500 |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2017-02-21 10:32:26 -0500 |
| commit | c95d017f9c221f309a4b74d8a033c1e99e784f90 (patch) | |
| tree | acc215397f92d7f53c0733b880eacaa8383c07ac /Modules/ExternalProject.cmake | |
| parent | 4b21290e204d02dd39f6ac404ba923d546f40925 (diff) | |
| download | cmake-c95d017f9c221f309a4b74d8a033c1e99e784f90.tar.gz | |
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/ExternalProject.cmake')
| -rw-r--r-- | Modules/ExternalProject.cmake | 5 |
1 files changed, 4 insertions, 1 deletions
diff --git a/Modules/ExternalProject.cmake b/Modules/ExternalProject.cmake index 325fbc398a..c3fd3c65bf 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. |