diff options
| author | Robert Maynard <rmaynard@nvidia.com> | 2022-03-21 19:05:39 (GMT) |
|---|---|---|
| committer | Robert Maynard <rmaynard@nvidia.com> | 2022-04-15 13:33:55 (GMT) |
| commit | 42f7e397894c5132b4706f478e62ce5d648119c1 (patch) | |
| tree | cbc53e9c4fad5d12e3c724011770a377fc572890 /Help/variable/CMAKE_FIND_USE_INSTALL_PREFIX.rst | |
| parent | 7fc248bde34c529c6f1312a56c7e82303238b9c1 (diff) | |
| download | CMake-42f7e397894c5132b4706f478e62ce5d648119c1.zip CMake-42f7e397894c5132b4706f478e62ce5d648119c1.tar.gz CMake-42f7e397894c5132b4706f478e62ce5d648119c1.tar.bz2 | |
Find: Support per call disabling of CMAKE_INSTALL_PREFIX
Fixes #23359
Diffstat (limited to 'Help/variable/CMAKE_FIND_USE_INSTALL_PREFIX.rst')
| -rw-r--r-- | Help/variable/CMAKE_FIND_USE_INSTALL_PREFIX.rst | 39 |
1 files changed, 39 insertions, 0 deletions
diff --git a/Help/variable/CMAKE_FIND_USE_INSTALL_PREFIX.rst b/Help/variable/CMAKE_FIND_USE_INSTALL_PREFIX.rst new file mode 100644 index 0000000..8494e95 --- /dev/null +++ b/Help/variable/CMAKE_FIND_USE_INSTALL_PREFIX.rst @@ -0,0 +1,39 @@ +CMAKE_FIND_USE_INSTALL_PREFIX +----------------------------------- + +.. versionadded:: 3.24 + +Controls the default behavior of the following commands for whether or not to +search the install location: + +* :command:`find_program` +* :command:`find_library` +* :command:`find_file` +* :command:`find_path` +* :command:`find_package` + +This is useful in cross-compiling environments. + +Due to backwards compatibility with :variable:`CMAKE_FIND_NO_INSTALL_PREFIX`, +the behavior of the find command change based on if this variable exists. + +============================== ============================ =========== + CMAKE_FIND_USE_INSTALL_PREFIX CMAKE_FIND_NO_INSTALL_PREFIX Search +============================== ============================ =========== + Not Defined On NO + Not Defined Off || Not Defined YES + Off On NO + Off Off || Not Defined NO + On On YES + On Off || Not Defined YES +============================== ============================ =========== + +By default this variable is not defined. Explicit options given to the above +commands take precedence over this variable. + +See also the :variable:`CMAKE_FIND_USE_CMAKE_PATH`, +:variable:`CMAKE_FIND_USE_CMAKE_ENVIRONMENT_PATH`, +:variable:`CMAKE_FIND_USE_SYSTEM_ENVIRONMENT_PATH`, +:variable:`CMAKE_FIND_USE_SYSTEM_PACKAGE_REGISTRY`, +:variable:`CMAKE_FIND_USE_PACKAGE_REGISTRY`, +and :variable:`CMAKE_FIND_USE_PACKAGE_ROOT_PATH` variables. |