mirror/CMake
1
0
Fork 0
mirror of https://github.com/Kitware/CMake.git synced 2026-03-09 10:00:12 -05:00
Code Issues Packages Projects Releases Wiki Activity

Document which environment variables effect CMAKE_SYSTEM_PREFIX_PATH

Browse Source
This commit is contained in:
Robert Maynard
2020-05-14 13:54:38 -04:00
parent 4dc9552686
commit 6b3d8f281e
5 changed files with 49 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
Help/variable/CMAKE_SYSTEM_PREFIX_PATH.rst
View File

@@ -8,11 +8,40 @@ CMAKE_SYSTEM_PREFIX_PATH
subdirectories (like ``bin``, ``lib``, or ``include``) as specified in its own
documentation.
By default this contains the standard directories for the current system, the
By default this contains the system directories for the current system, the
:variable:`CMAKE_INSTALL_PREFIX`, and the :variable:`CMAKE_STAGING_PREFIX`.
The installation and staging prefixes may be excluded by setting
the :variable:`CMAKE_FIND_NO_INSTALL_PREFIX` variable.
The system directories that are contained in ``CMAKE_SYSTEM_PREFIX_PATH`` are
locations that typically include installed software. An example being
``/usr/local`` for UNIX based platforms. In addition to standard platform
locations, CMake will also add values to ``CMAKE_SYSTEM_PREFIX_PATH`` based on
environment variables. The environment variables and search locations that
CMake uses may evolve over time, as platforms and their conventions also
evolve. The following provides an indicative list of environment variables
and locations that CMake searches, but they are subject to change:
CrayLinuxEnvironment:
* ``ENV{SYSROOT_DIR}/``
* ``ENV{SYSROOT_DIR}/usr``
* ``ENV{SYSROOT_DIR}/usr/local``
Darwin:
* ``ENV{SDKROOT}/usr`` When ``CMAKE_OSX_SYSROOT`` is not explicitly specified.
OpenBSD:
* ``ENV{LOCALBASE}``
Windows:
* ``ENV{ProgramW6432}``
* ``ENV{ProgramFiles}``
* ``ENV{ProgramFiles(x86)}``
* ``ENV{SystemDrive}/Program Files``
* ``ENV{SystemDrive}/Program Files (x86)``
``CMAKE_SYSTEM_PREFIX_PATH`` is *not* intended to be modified by the project;
use :variable:`CMAKE_PREFIX_PATH` for this.