Help: Polish CMAKE{,_SYSTEM}_IGNORE_PREFIX_PATH documentation

This commit is contained in:
Brad King
2022-02-03 07:48:10 -05:00
parent 23b1d8f03c
commit 51aaea34d6
2 changed files with 19 additions and 19 deletions
+10 -10
View File
@@ -1,17 +1,17 @@
CMAKE_IGNORE_PREFIX_PATH CMAKE_IGNORE_PREFIX_PATH
------------------------ ------------------------
:ref:`Semicolon-separated list <CMake Language Lists>` of prefix to be *ignored* by :ref:`Semicolon-separated list <CMake Language Lists>` of prefixes to be
the :command:`find_program`, :command:`find_library`, :command:`find_file`, *ignored* by the :command:`find_program`, :command:`find_library`,
:command:`find_path`, and :command:`find_package` commands. This is useful in cross-compiling :command:`find_file`, :command:`find_path`, and :command:`find_package`
environments where some system directories contain incompatible but commands. This is useful in cross-compiling environments where some
possibly linkable libraries. For example, on cross-compiled cluster system directories contain incompatible but possibly linkable libraries.
environments, this allows a user to ignore directories containing For example, on cross-compiled cluster environments, this allows a user
libraries meant for the front-end machine. 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. By default this is empty; it is intended to be set by the project and/or
Note that ``CMAKE_IGNORE_PREFIX_PATH`` takes a list of prefixes, *not* the end user. Note that ``CMAKE_IGNORE_PREFIX_PATH`` takes a list of
a list of directory names. prefixes, *not* a list of directory names.
See also the :variable:`CMAKE_PREFIX_PATH`, :variable:`CMAKE_LIBRARY_PATH`, See also the :variable:`CMAKE_PREFIX_PATH`, :variable:`CMAKE_LIBRARY_PATH`,
:variable:`CMAKE_INCLUDE_PATH`, and :variable:`CMAKE_PROGRAM_PATH` variables. :variable:`CMAKE_INCLUDE_PATH`, and :variable:`CMAKE_PROGRAM_PATH` variables.
@@ -1,17 +1,17 @@
CMAKE_SYSTEM_IGNORE_PREFIX_PATH CMAKE_SYSTEM_IGNORE_PREFIX_PATH
------------------------------- -------------------------------
:ref:`Semicolon-separated list <CMake Language Lists>` of prefixes to be *ignored* by :ref:`Semicolon-separated list <CMake Language Lists>` of prefixes to be
the :command:`find_program`, :command:`find_library`, :command:`find_file`, *ignored* by the :command:`find_program`, :command:`find_library`,
:command:`find_path`, and :command:`find_package` commands. This is useful in cross-compiling :command:`find_file`, :command:`find_path`, and :command:`find_package`
environments where some system directories contain incompatible but commands. This is useful in cross-compiling environments where some
possibly linkable libraries. For example, on cross-compiled cluster system directories contain incompatible but possibly linkable libraries.
environments, this allows a user to ignore directories containing For example, on cross-compiled cluster environments, this allows a user
libraries meant for the front-end machine. to ignore directories containing libraries meant for the front-end machine.
By default this contains a list of directories containing incompatible By default this contains a list of directories containing incompatible
binaries for the host system. See the :variable:`CMAKE_IGNORE_PREFIX_PATH` variable binaries for the host system. See the :variable:`CMAKE_IGNORE_PREFIX_PATH`
that is intended to be set by the project. variable that is intended to be set by the project and/or the end user.
See also the :variable:`CMAKE_SYSTEM_PREFIX_PATH`, See also the :variable:`CMAKE_SYSTEM_PREFIX_PATH`,
:variable:`CMAKE_SYSTEM_LIBRARY_PATH`, :variable:`CMAKE_SYSTEM_INCLUDE_PATH`, :variable:`CMAKE_SYSTEM_LIBRARY_PATH`, :variable:`CMAKE_SYSTEM_INCLUDE_PATH`,