summaryrefslogtreecommitdiffstats
path: root/Help/command
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2022-03-15 16:48:33 (GMT)
committerKitware Robot <kwrobot@kitware.com>2022-03-15 16:48:42 (GMT)
commitcffc2b69428a1587f833958b8915540473912b28 (patch)
tree0981cc74c25cdcf060609cf3e7af5e3d2e05dbce /Help/command
parent44fccc80fa38fcfa2afea4bad7ddb17d6baec281 (diff)
parent5cb0a730c9fa4f1be2edccd0fe9bfa1d59a2787d (diff)
downloadCMake-cffc2b69428a1587f833958b8915540473912b28.zip
CMake-cffc2b69428a1587f833958b8915540473912b28.tar.gz
CMake-cffc2b69428a1587f833958b8915540473912b28.tar.bz2
Merge topic 'doc-ignore-prefix-paths'
5cb0a730c9 Help: Clarify behavior of search ignore-related variables Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !7056
Diffstat (limited to 'Help/command')
-rw-r--r--Help/command/FIND_XXX.txt5
-rw-r--r--Help/command/find_package.rst5
2 files changed, 10 insertions, 0 deletions
diff --git a/Help/command/FIND_XXX.txt b/Help/command/FIND_XXX.txt
index 5b63e1c..ee6c1cc 100644
--- a/Help/command/FIND_XXX.txt
+++ b/Help/command/FIND_XXX.txt
@@ -170,6 +170,11 @@ If ``NO_DEFAULT_PATH`` is not specified, the search process is as follows:
or in the short-hand version of the command.
These are typically hard-coded guesses.
+The :variable:`CMAKE_IGNORE_PATH`, :variable:`CMAKE_IGNORE_PREFIX_PATH`,
+:variable:`CMAKE_SYSTEM_IGNORE_PATH` and
+:variable:`CMAKE_SYSTEM_IGNORE_PREFIX_PATH` variables can also cause some
+of the above locations to be ignored.
+
.. versionadded:: 3.16
Added ``CMAKE_FIND_USE_<CATEGORY>_PATH`` variables to globally disable
various search locations.
diff --git a/Help/command/find_package.rst b/Help/command/find_package.rst
index 4a381fb..e43b7bd 100644
--- a/Help/command/find_package.rst
+++ b/Help/command/find_package.rst
@@ -369,6 +369,11 @@ enabled.
9. Search paths specified by the ``PATHS`` option. These are typically
hard-coded guesses.
+The :variable:`CMAKE_IGNORE_PATH`, :variable:`CMAKE_IGNORE_PREFIX_PATH`,
+:variable:`CMAKE_SYSTEM_IGNORE_PATH` and
+:variable:`CMAKE_SYSTEM_IGNORE_PREFIX_PATH` variables can also cause some
+of the above locations to be ignored.
+
.. versionadded:: 3.16
Added the ``CMAKE_FIND_USE_<CATEGORY>`` variables to globally disable
various search locations.