summaryrefslogtreecommitdiffstats
path: root/Help/command
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2019-10-28 15:33:05 (GMT)
committerBrad King <brad.king@kitware.com>2019-10-28 15:33:05 (GMT)
commita575fbc3cb202632f551ac134ff183665abe4487 (patch)
treee335780c811f8f2c10af09074d273a053426ad56 /Help/command
parent62267715fe6f69162b834c6ee96ca6073ff96d15 (diff)
parenta0a7a45dbcc17000a5cb8223e86908f41c40faf5 (diff)
downloadCMake-a575fbc3cb202632f551ac134ff183665abe4487.zip
CMake-a575fbc3cb202632f551ac134ff183665abe4487.tar.gz
CMake-a575fbc3cb202632f551ac134ff183665abe4487.tar.bz2
Merge branch 'docs-find-vars' into release-3.16
Merge-request: !3952
Diffstat (limited to 'Help/command')
-rw-r--r--Help/command/FIND_XXX.txt13
1 files changed, 7 insertions, 6 deletions
diff --git a/Help/command/FIND_XXX.txt b/Help/command/FIND_XXX.txt
index 40f1c1a..42bf52b 100644
--- a/Help/command/FIND_XXX.txt
+++ b/Help/command/FIND_XXX.txt
@@ -79,15 +79,16 @@ If ``NO_DEFAULT_PATH`` is not specified, the search process is as follows:
|prefix_XXX_SUBDIR| for each ``<prefix>`` in
:variable:`CMAKE_SYSTEM_PREFIX_PATH`
-1. If called from within a find module loaded by
+1. If called from within a find module or any other script loaded by a call to
:command:`find_package(<PackageName>)`, search prefixes unique to the
- current package being found. Specifically look in the
+ current package being found. Specifically, look in the
:variable:`<PackageName>_ROOT` CMake variable and the
:envvar:`<PackageName>_ROOT` environment variable.
- The package root variables are maintained as a stack so if called from
- nested find modules, root paths from the parent's find module will be
- searched after paths from the current module,
- i.e. ``<CurrentPackage>_ROOT``, ``ENV{<CurrentPackage>_ROOT}``,
+ The package root variables are maintained as a stack, so if called from
+ nested find modules or config packages, root paths from the parent's find
+ module or config package will be searched after paths from the current
+ module or package. In other words, the search order would be
+ ``<CurrentPackage>_ROOT``, ``ENV{<CurrentPackage>_ROOT}``,
``<ParentPackage>_ROOT``, ``ENV{<ParentPackage>_ROOT}``, etc.
This can be skipped if ``NO_PACKAGE_ROOT_PATH`` is passed or by setting
the :variable:`CMAKE_FIND_USE_PACKAGE_ROOT_PATH` to ``FALSE``.