diff options
| author | Brad King <brad.king@kitware.com> | 2016-11-21 11:52:32 -0500 |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2016-11-21 11:52:32 -0500 |
| commit | 47dd761379cfc55b6630835e2d30d1cd07b15f9a (patch) | |
| tree | c9daa2fcb60fc54881dcd501d89d46db1f7a7675 /Help | |
| parent | 37966a57992a8a2cc59fd663a4dea985a0be248c (diff) | |
| parent | df9fea7f495cc0cc495782abfe4a7b0a0a3122ec (diff) | |
| download | cmake-47dd761379cfc55b6630835e2d30d1cd07b15f9a.tar.gz | |
Merge branch 'doc-CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT' into release
Diffstat (limited to 'Help')
| -rw-r--r-- | Help/manual/cmake-variables.7.rst | 1 | ||||
| -rw-r--r-- | Help/variable/CMAKE_INSTALL_PREFIX.rst | 2 | ||||
| -rw-r--r-- | Help/variable/CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT.rst | 14 |
3 files changed, 17 insertions, 0 deletions
diff --git a/Help/manual/cmake-variables.7.rst b/Help/manual/cmake-variables.7.rst index ab69303172..31c0a84d55 100644 --- a/Help/manual/cmake-variables.7.rst +++ b/Help/manual/cmake-variables.7.rst @@ -148,6 +148,7 @@ Variables that Change Behavior /variable/CMAKE_INSTALL_DEFAULT_COMPONENT_NAME /variable/CMAKE_INSTALL_MESSAGE /variable/CMAKE_INSTALL_PREFIX + /variable/CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT /variable/CMAKE_LIBRARY_PATH /variable/CMAKE_MFC_FLAG /variable/CMAKE_MODULE_PATH diff --git a/Help/variable/CMAKE_INSTALL_PREFIX.rst b/Help/variable/CMAKE_INSTALL_PREFIX.rst index 86f194463f..7bd87d6aa1 100644 --- a/Help/variable/CMAKE_INSTALL_PREFIX.rst +++ b/Help/variable/CMAKE_INSTALL_PREFIX.rst @@ -6,6 +6,8 @@ Install directory used by :command:`install`. If ``make install`` is invoked or ``INSTALL`` is built, this directory is prepended onto all install directories. This variable defaults to ``/usr/local`` on UNIX and ``c:/Program Files/${PROJECT_NAME}`` on Windows. +See :variable:`CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT` for how a +project might choose its own default. On UNIX one can use the ``DESTDIR`` mechanism in order to relocate the whole installation. ``DESTDIR`` means DESTination DIRectory. It is diff --git a/Help/variable/CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT.rst b/Help/variable/CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT.rst new file mode 100644 index 0000000000..2a5842d4c3 --- /dev/null +++ b/Help/variable/CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT.rst @@ -0,0 +1,14 @@ +CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT +------------------------------------------- + +CMake sets this variable to a ``TRUE`` value when the +:variable:`CMAKE_INSTALL_PREFIX` has just been initialized to +its default value, typically on the first run of CMake within +a new build tree. This can be used by project code to change +the default without overriding a user-provided value: + +.. code-block:: cmake + + if(CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT) + set(CMAKE_INSTALL_PREFIX "/my/default" CACHE PATH "..." FORCE) + endif() |