Kitware/CMake
1
0
Fork 0
mirror of https://github.com/Kitware/CMake.git synced 2025-10-14 02:08:27 +08:00
Code Issues Projects Releases Wiki Activity

Help: Cross-reference and clarify CMAKE_FIND_NO_INSTALL_PREFIX docs

Browse Source 
Suggested-by: Luke Yeager <lukeyeager@users.noreply.github.com>
This commit is contained in:
Brad King
2017-08-30 15:05:04 -04:00
parent a0ef210da8
commit 952331cded
2 changed files with 19 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
Help/variable/CMAKE_FIND_NO_INSTALL_PREFIX.rst
View File

@@ -1,15 +1,19 @@
CMAKE_FIND_NO_INSTALL_PREFIX
----------------------------
Ignore the :variable:`CMAKE_INSTALL_PREFIX` when searching for assets.
Exclude the values of the :variable:`CMAKE_INSTALL_PREFIX` and
:variable:`CMAKE_STAGING_PREFIX` variables from
:variable:`CMAKE_SYSTEM_PREFIX_PATH`. CMake adds these project-destination
prefixes to :variable:`CMAKE_SYSTEM_PREFIX_PATH` by default in order to
support building a series of dependent packages and installing them into
a common prefix. Set ``CMAKE_FIND_NO_INSTALL_PREFIX`` to ``TRUE``
to suppress this behavior.
CMake adds the :variable:`CMAKE_INSTALL_PREFIX` and the
:variable:`CMAKE_STAGING_PREFIX` variable to the
:variable:`CMAKE_SYSTEM_PREFIX_PATH` by default. This variable may be set
on the command line to control that behavior.
The :variable:`CMAKE_SYSTEM_PREFIX_PATH` is initialized on the first call to a
:command:`project` or :command:`enable_language` command. Therefore one must
set ``CMAKE_FIND_NO_INSTALL_PREFIX`` before this in order to take effect. A
user may set the variable as a cache entry on the command line to achieve this.
Set ``CMAKE_FIND_NO_INSTALL_PREFIX`` to ``TRUE`` to tell
:command:`find_package` not to search in the :variable:`CMAKE_INSTALL_PREFIX`
or :variable:`CMAKE_STAGING_PREFIX` by default. Note that the
prefix may still be searched for other reasons, such as being the same prefix
as the CMake installation, or for being a built-in system prefix.
Note that the prefix(es) may still be searched for other reasons, such as being
the same prefix as the CMake installation, or for being a built-in system
prefix.

7
Help/variable/CMAKE_SYSTEM_PREFIX_PATH.rst
View File

@@ -10,8 +10,11 @@ documentation.
By default this contains the standard directories for the current system, the
:variable:`CMAKE_INSTALL_PREFIX`, and the :variable:`CMAKE_STAGING_PREFIX`.
It is *not* intended to be modified by the project; use
:variable:`CMAKE_PREFIX_PATH` for this.
The installation and staging prefixes may be excluded by setting
the :variable:`CMAKE_FIND_NO_INSTALL_PREFIX` variable.
``CMAKE_SYSTEM_PREFIX_PATH`` is *not* intended to be modified by the project;
use :variable:`CMAKE_PREFIX_PATH` for this.
See also :variable:`CMAKE_SYSTEM_INCLUDE_PATH`,
:variable:`CMAKE_SYSTEM_LIBRARY_PATH`, :variable:`CMAKE_SYSTEM_PROGRAM_PATH`,