diff options
| author | Brad King <brad.king@kitware.com> | 2017-08-31 14:11:09 (GMT) |
|---|---|---|
| committer | Kitware Robot <kwrobot@kitware.com> | 2017-08-31 14:11:21 (GMT) |
| commit | 02d24c9ed29ff84104413f8543f1063e1c0f2f4f (patch) | |
| tree | db36a27d7bb49acf91e3b1be47e015fce459f1cc /Help | |
| parent | b40a43a1f4be3c8ba70284fda9d04ad0f413b171 (diff) | |
| parent | 952331cded57e2a4293c1d7d78bd5e3b7b0ace9a (diff) | |
| download | CMake-02d24c9ed29ff84104413f8543f1063e1c0f2f4f.zip CMake-02d24c9ed29ff84104413f8543f1063e1c0f2f4f.tar.gz CMake-02d24c9ed29ff84104413f8543f1063e1c0f2f4f.tar.bz2 | |
Merge topic 'doc-xref-prefix-path'
952331cd Help: Cross-reference and clarify CMAKE_FIND_NO_INSTALL_PREFIX docs
Acked-by: Kitware Robot <kwrobot@kitware.com>
Acked-by: Luke Yeager <luke.yeager@gmail.com>
Merge-request: !1213
Diffstat (limited to 'Help')
| -rw-r--r-- | Help/variable/CMAKE_FIND_NO_INSTALL_PREFIX.rst | 24 | ||||
| -rw-r--r-- | Help/variable/CMAKE_SYSTEM_PREFIX_PATH.rst | 7 |
2 files changed, 19 insertions, 12 deletions
diff --git a/Help/variable/CMAKE_FIND_NO_INSTALL_PREFIX.rst b/Help/variable/CMAKE_FIND_NO_INSTALL_PREFIX.rst index c49d264..789dc99 100644 --- a/Help/variable/CMAKE_FIND_NO_INSTALL_PREFIX.rst +++ b/Help/variable/CMAKE_FIND_NO_INSTALL_PREFIX.rst @@ -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. diff --git a/Help/variable/CMAKE_SYSTEM_PREFIX_PATH.rst b/Help/variable/CMAKE_SYSTEM_PREFIX_PATH.rst index e74dfad..38b2f8d 100644 --- a/Help/variable/CMAKE_SYSTEM_PREFIX_PATH.rst +++ b/Help/variable/CMAKE_SYSTEM_PREFIX_PATH.rst @@ -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`, |