Help: Clarify that <PackageName>_ROOT variable names are case-preserved

The name comes from the case-preserved first argument to
`find_package`.
This commit is contained in:
Brad King
2023-02-08 14:04:13 -05:00
parent fc4e31d703
commit 20e727a408
3 changed files with 10 additions and 9 deletions

View File

@@ -370,7 +370,8 @@ enabled.
1. .. versionadded:: 3.12
Search paths specified in the :variable:`<PackageName>_ROOT` CMake
variable and the :envvar:`<PackageName>_ROOT` environment variable,
where ``<PackageName>`` is the package to be found.
where ``<PackageName>`` is the package to be found
(the case-preserved first argument to ``find_package``).
The package root variables are maintained as a stack so if
called from within a find module, root paths from the parent's find
module will also be searched after paths for the current package.