summaryrefslogtreecommitdiffstats
path: root/Help/command/FIND_XXX.txt
diff options
context:
space:
mode:
authorCraig Scott <craig.scott@crascit.com>2022-03-09 11:15:34 (GMT)
committerCraig Scott <craig.scott@crascit.com>2022-03-13 03:29:05 (GMT)
commit5cb0a730c9fa4f1be2edccd0fe9bfa1d59a2787d (patch)
treeebd3d93a6262ed3b1631d9474ed56b6c3d523343 /Help/command/FIND_XXX.txt
parent736e80dbcafc4c46950688b915e0688f1b817862 (diff)
downloadCMake-5cb0a730c9fa4f1be2edccd0fe9bfa1d59a2787d.zip
CMake-5cb0a730c9fa4f1be2edccd0fe9bfa1d59a2787d.tar.gz
CMake-5cb0a730c9fa4f1be2edccd0fe9bfa1d59a2787d.tar.bz2
Help: Clarify behavior of search ignore-related variables
Not all the behaviors of CMake variables for ignoring search locations by find_...() commands were fully documented. Add the missing effects, clarify the wording and restructure the way the details are assembled to reduce duplication. Also improve the cross-referencing to ensure all the related variables are more discoverable. Issue: #20878
Diffstat (limited to 'Help/command/FIND_XXX.txt')
-rw-r--r--Help/command/FIND_XXX.txt5
1 files changed, 5 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.