diff options
| author | Brad King <brad.king@kitware.com> | 2015-06-25 14:04:42 (GMT) |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2015-06-25 14:05:23 (GMT) |
| commit | 3117b5feecf94914361e3683f1206f2d9d724c89 (patch) | |
| tree | 2d087e4e00d20072cef160a92115ec6a2d1c9fcc /Help/variable/CMAKE_SYSTEM_IGNORE_PATH.rst | |
| parent | a6916a6c6e397bda8b381f65dbfc59d3c52f8525 (diff) | |
| download | CMake-3117b5feecf94914361e3683f1206f2d9d724c89.zip CMake-3117b5feecf94914361e3683f1206f2d9d724c89.tar.gz CMake-3117b5feecf94914361e3683f1206f2d9d724c89.tar.bz2 | |
Help: Revise CMAKE_*_PATH and CMAKE_SYSTEM_*_PATH variable docs (#15631)
Improve reStructuredText formatting and cross-references. Specify
explicitly that each variable may be set to a ;-list of multiple values.
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. |