kolan
/
CMake
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Help: Document CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT variable 

This variable documentation was simply missing.

Suggested-by: Craig Scott <craig.scott@crascit.com>
This commit is contained in:
Brad King 2016-11-21 11:49:33 -05:00
parent 5cfc2e926a
commit df9fea7f49
3 changed files with 17 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
Help/manual/cmake-variables.7.rst
View File

@ -148,6 +148,7 @@ Variables that Change Behavior
/variable/CMAKE_INSTALL_DEFAULT_COMPONENT_NAME /variable/CMAKE_INSTALL_DEFAULT_COMPONENT_NAME
/variable/CMAKE_INSTALL_MESSAGE /variable/CMAKE_INSTALL_MESSAGE
/variable/CMAKE_INSTALL_PREFIX /variable/CMAKE_INSTALL_PREFIX
/variable/CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT
/variable/CMAKE_LIBRARY_PATH /variable/CMAKE_LIBRARY_PATH
/variable/CMAKE_MFC_FLAG /variable/CMAKE_MFC_FLAG
/variable/CMAKE_MODULE_PATH /variable/CMAKE_MODULE_PATH

2
Help/variable/CMAKE_INSTALL_PREFIX.rst
View File

@ -6,6 +6,8 @@ Install directory used by :command:`install`.
If ``make install`` is invoked or ``INSTALL`` is built, this directory is If ``make install`` is invoked or ``INSTALL`` is built, this directory is
prepended onto all install directories. This variable defaults to prepended onto all install directories. This variable defaults to
``/usr/local`` on UNIX and ``c:/Program Files/${PROJECT_NAME}`` on Windows. ``/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 On UNIX one can use the ``DESTDIR`` mechanism in order to relocate the
whole installation. ``DESTDIR`` means DESTination DIRectory. It is whole installation. ``DESTDIR`` means DESTination DIRectory. It is

14
Help/variable/CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT.rst Normal file
View File

@ -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()