summaryrefslogtreecommitdiffstats
path: root/Help/command
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2023-02-08 19:04:13 (GMT)
committerBrad King <brad.king@kitware.com>2023-02-08 19:06:38 (GMT)
commit20e727a408deeac7a6b0b27c729f4d27fc7cc43a (patch)
tree4c78a12e986adfa5b3684903dc92bc8d01274b3a /Help/command
parentfc4e31d7034153cb9d72f3d812ad0c5459580dd3 (diff)
downloadCMake-20e727a408deeac7a6b0b27c729f4d27fc7cc43a.zip
CMake-20e727a408deeac7a6b0b27c729f4d27fc7cc43a.tar.gz
CMake-20e727a408deeac7a6b0b27c729f4d27fc7cc43a.tar.bz2
Help: Clarify that <PackageName>_ROOT variable names are case-preserved
The name comes from the case-preserved first argument to `find_package`.
Diffstat (limited to 'Help/command')
-rw-r--r--Help/command/find_package.rst3
1 files changed, 2 insertions, 1 deletions
diff --git a/Help/command/find_package.rst b/Help/command/find_package.rst
index c99c73d..de4cb88 100644
--- a/Help/command/find_package.rst
+++ b/Help/command/find_package.rst
@@ -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.