diff options
| author | Brad King <brad.king@kitware.com> | 2015-06-25 14:39:25 (GMT) |
|---|---|---|
| committer | CMake Topic Stage <kwrobot@kitware.com> | 2015-06-25 14:39:25 (GMT) |
| commit | 2a56a21c838875a80bc7450fcc0955a5e60da7cf (patch) | |
| tree | 83b24a126825342503667fefa0366e09acc45364 /Help/variable/CMAKE_SYSTEM_IGNORE_PATH.rst | |
| parent | eaafe3bd56c891b11df670396825df09868c9c93 (diff) | |
| parent | 3117b5feecf94914361e3683f1206f2d9d724c89 (diff) | |
| download | CMake-2a56a21c838875a80bc7450fcc0955a5e60da7cf.zip CMake-2a56a21c838875a80bc7450fcc0955a5e60da7cf.tar.gz CMake-2a56a21c838875a80bc7450fcc0955a5e60da7cf.tar.bz2 | |
Merge topic 'doc-find-path-variables'
3117b5fe Help: Revise CMAKE_*_PATH and CMAKE_SYSTEM_*_PATH variable docs (#15631)
Diffstat (limited to 'Help/variable/CMAKE_SYSTEM_IGNORE_PATH.rst')
| -rw-r--r-- | Help/variable/CMAKE_SYSTEM_IGNORE_PATH.rst | 25 |
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. |