diff options
Diffstat (limited to 'Help/variable/CMAKE_IGNORE_PATH.rst')
| -rw-r--r-- | Help/variable/CMAKE_IGNORE_PATH.rst | 27 |
1 files changed, 14 insertions, 13 deletions
diff --git a/Help/variable/CMAKE_IGNORE_PATH.rst b/Help/variable/CMAKE_IGNORE_PATH.rst index a818f74..92f3770 100644 --- a/Help/variable/CMAKE_IGNORE_PATH.rst +++ b/Help/variable/CMAKE_IGNORE_PATH.rst @@ -1,17 +1,18 @@ CMAKE_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 is empty; it is intended to be set -by the project. Note that CMAKE_IGNORE_PATH takes a list of directory -names, NOT a list of prefixes. If you want to ignore paths under -prefixes (bin, include, lib, etc.), you'll need to specify them -explicitly. See also CMAKE_PREFIX_PATH, CMAKE_LIBRARY_PATH, -CMAKE_INCLUDE_PATH, CMAKE_PROGRAM_PATH. +By default this is empty; it is intended to be set by the project. +Note that ``CMAKE_IGNORE_PATH`` takes a list of directory names, *not* +a list of prefixes. To ignore paths under prefixes (``bin``, ``include``, +``lib``, etc.), specify them explicitly. + +See also the :variable:`CMAKE_PREFIX_PATH`, :variable:`CMAKE_LIBRARY_PATH`, +:variable:`CMAKE_INCLUDE_PATH`, and :variable:`CMAKE_PROGRAM_PATH` variables. |