summaryrefslogtreecommitdiffstats
path: root/Help/variable/CMAKE_SYSTEM_IGNORE_PREFIX_PATH.rst
diff options
context:
space:
mode:
authorKyle Edwards <kyle.edwards@kitware.com>2022-01-26 21:35:54 (GMT)
committerKyle Edwards <kyle.edwards@kitware.com>2022-02-02 16:09:00 (GMT)
commit201d8c429843e9e57f833fcca8794f532e6d3028 (patch)
treea66090c1d5445466e189f149a11c1b1bfde84667 /Help/variable/CMAKE_SYSTEM_IGNORE_PREFIX_PATH.rst
parentbd805a51ae4b5be5be6bbadf4afab108fcf4ddb3 (diff)
downloadCMake-201d8c429843e9e57f833fcca8794f532e6d3028.zip
CMake-201d8c429843e9e57f833fcca8794f532e6d3028.tar.gz
CMake-201d8c429843e9e57f833fcca8794f532e6d3028.tar.bz2
find_*(): Add CMAKE_IGNORE_PREFIX_PATH variable
Fixes: #20878
Diffstat (limited to 'Help/variable/CMAKE_SYSTEM_IGNORE_PREFIX_PATH.rst')
-rw-r--r--Help/variable/CMAKE_SYSTEM_IGNORE_PREFIX_PATH.rst18
1 files changed, 18 insertions, 0 deletions
diff --git a/Help/variable/CMAKE_SYSTEM_IGNORE_PREFIX_PATH.rst b/Help/variable/CMAKE_SYSTEM_IGNORE_PREFIX_PATH.rst
new file mode 100644
index 0000000..b177834
--- /dev/null
+++ b/Help/variable/CMAKE_SYSTEM_IGNORE_PREFIX_PATH.rst
@@ -0,0 +1,18 @@
+CMAKE_SYSTEM_IGNORE_PREFIX_PATH
+-------------------------------
+
+:ref:`Semicolon-separated list <CMake Language Lists>` of prefixes to be *ignored* by
+the :command:`find_program`, :command:`find_library`, :command:`find_file`,
+:command:`find_path`, and :command:`find_package` commands. This is useful in cross-compiling
+environments where some system directories contain incompatible but
+possibly linkable libraries. For example, on cross-compiled cluster
+environments, this allows a user to ignore directories containing
+libraries meant for the front-end machine.
+
+By default this contains a list of directories containing incompatible
+binaries for the host system. See the :variable:`CMAKE_IGNORE_PREFIX_PATH` variable
+that is intended to be set by the project.
+
+See also the :variable:`CMAKE_SYSTEM_PREFIX_PATH`,
+:variable:`CMAKE_SYSTEM_LIBRARY_PATH`, :variable:`CMAKE_SYSTEM_INCLUDE_PATH`,
+and :variable:`CMAKE_SYSTEM_PROGRAM_PATH` variables.