From 51aaea34d6da974a9135514ccc20e2fe16716efe Mon Sep 17 00:00:00 2001 From: Brad King Date: Thu, 3 Feb 2022 07:48:10 -0500 Subject: Help: Polish CMAKE{,_SYSTEM}_IGNORE_PREFIX_PATH documentation --- Help/variable/CMAKE_IGNORE_PREFIX_PATH.rst | 20 ++++++++++---------- Help/variable/CMAKE_SYSTEM_IGNORE_PREFIX_PATH.rst | 18 +++++++++--------- 2 files changed, 19 insertions(+), 19 deletions(-) diff --git a/Help/variable/CMAKE_IGNORE_PREFIX_PATH.rst b/Help/variable/CMAKE_IGNORE_PREFIX_PATH.rst index 45e51dd..5ebb349 100644 --- a/Help/variable/CMAKE_IGNORE_PREFIX_PATH.rst +++ b/Help/variable/CMAKE_IGNORE_PREFIX_PATH.rst @@ -1,17 +1,17 @@ CMAKE_IGNORE_PREFIX_PATH ------------------------ -:ref:`Semicolon-separated list ` of prefix 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. +:ref:`Semicolon-separated list ` 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 is empty; it is intended to be set by the project. -Note that ``CMAKE_IGNORE_PREFIX_PATH`` takes a list of prefixes, *not* -a list of directory names. +By default this is empty; it is intended to be set by the project and/or +the end user. Note that ``CMAKE_IGNORE_PREFIX_PATH`` takes a list of +prefixes, *not* a list of directory names. See also the :variable:`CMAKE_PREFIX_PATH`, :variable:`CMAKE_LIBRARY_PATH`, :variable:`CMAKE_INCLUDE_PATH`, and :variable:`CMAKE_PROGRAM_PATH` variables. diff --git a/Help/variable/CMAKE_SYSTEM_IGNORE_PREFIX_PATH.rst b/Help/variable/CMAKE_SYSTEM_IGNORE_PREFIX_PATH.rst index b177834..a2e42dd 100644 --- a/Help/variable/CMAKE_SYSTEM_IGNORE_PREFIX_PATH.rst +++ b/Help/variable/CMAKE_SYSTEM_IGNORE_PREFIX_PATH.rst @@ -1,17 +1,17 @@ CMAKE_SYSTEM_IGNORE_PREFIX_PATH ------------------------------- -:ref:`Semicolon-separated list ` 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. +:ref:`Semicolon-separated list ` 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. +binaries for the host system. See the :variable:`CMAKE_IGNORE_PREFIX_PATH` +variable that is intended to be set by the project and/or the end user. See also the :variable:`CMAKE_SYSTEM_PREFIX_PATH`, :variable:`CMAKE_SYSTEM_LIBRARY_PATH`, :variable:`CMAKE_SYSTEM_INCLUDE_PATH`, -- cgit v0.12