summaryrefslogtreecommitdiffstats
path: root/Help/variable/CMAKE_SYSTEM_IGNORE_PATH.rst
diff options
context:
space:
mode:
Diffstat (limited to 'Help/variable/CMAKE_SYSTEM_IGNORE_PATH.rst')
-rw-r--r--Help/variable/CMAKE_SYSTEM_IGNORE_PATH.rst25
1 files changed, 14 insertions, 11 deletions
diff --git a/Help/variable/CMAKE_SYSTEM_IGNORE_PATH.rst b/Help/variable/CMAKE_SYSTEM_IGNORE_PATH.rst
index 9e6b195..4ad7e33 100644
--- a/Help/variable/CMAKE_SYSTEM_IGNORE_PATH.rst
+++ b/Help/variable/CMAKE_SYSTEM_IGNORE_PATH.rst
@@ -1,15 +1,18 @@
CMAKE_SYSTEM_IGNORE_PATH
------------------------
-Path to be ignored by FIND_XXX() commands.
+:ref:`;-list <CMake Language Lists>` of directories to be *ignored* by
+the :command:`find_program`, :command:`find_library`, :command:`find_file`,
+and :command:`find_path` 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.
-Specifies directories to be ignored by searches in FIND_XXX()
-commands. This is useful in cross-compiled 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 that modules like FindX11 (and others) would
-normally search. By default this contains a list of directories
-containing incompatible binaries for the host system. See also
-CMAKE_SYSTEM_PREFIX_PATH, CMAKE_SYSTEM_LIBRARY_PATH,
-CMAKE_SYSTEM_INCLUDE_PATH, and CMAKE_SYSTEM_PROGRAM_PATH.
+By default this contains a list of directories containing incompatible
+binaries for the host system. See the :variable:`CMAKE_IGNORE_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.