From 20e727a408deeac7a6b0b27c729f4d27fc7cc43a Mon Sep 17 00:00:00 2001 From: Brad King Date: Wed, 8 Feb 2023 14:04:13 -0500 Subject: Help: Clarify that _ROOT variable names are case-preserved The name comes from the case-preserved first argument to `find_package`. --- Help/command/find_package.rst | 3 ++- Help/envvar/PackageName_ROOT.rst | 8 ++++---- Help/variable/PackageName_ROOT.rst | 8 ++++---- 3 files changed, 10 insertions(+), 9 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:`_ROOT` CMake variable and the :envvar:`_ROOT` environment variable, - where ```` is the package to be found. + where ```` 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. diff --git a/Help/envvar/PackageName_ROOT.rst b/Help/envvar/PackageName_ROOT.rst index 0cdd384..fa8c385 100644 --- a/Help/envvar/PackageName_ROOT.rst +++ b/Help/envvar/PackageName_ROOT.rst @@ -7,10 +7,10 @@ Calls to :command:`find_package()` will search in prefixes specified by the ``_ROOT`` environment variable, where -```` is the name given to the :command:`find_package` call -and ``_ROOT`` is literal. For example, ``find_package(Foo)`` will search -prefixes specified in the ``Foo_ROOT`` environment variable (if set). -See policy :policy:`CMP0074`. +```` is the (case-preserved) name given to the +:command:`find_package` call and ``_ROOT`` is literal. +For example, ``find_package(Foo)`` will search prefixes specified in the +``Foo_ROOT`` environment variable (if set). See policy :policy:`CMP0074`. This variable may hold a single prefix or a list of prefixes separated by ``:`` on UNIX or ``;`` on Windows (the same as the ``PATH`` environment diff --git a/Help/variable/PackageName_ROOT.rst b/Help/variable/PackageName_ROOT.rst index 98ba20e..6b17be3 100644 --- a/Help/variable/PackageName_ROOT.rst +++ b/Help/variable/PackageName_ROOT.rst @@ -5,10 +5,10 @@ Calls to :command:`find_package()` will search in prefixes specified by the ``_ROOT`` CMake variable, where -```` is the name given to the :command:`find_package` call -and ``_ROOT`` is literal. For example, ``find_package(Foo)`` will search -prefixes specified in the ``Foo_ROOT`` CMake variable (if set). -See policy :policy:`CMP0074`. +```` is the (case-preserved) name given to the +:command:`find_package` call and ``_ROOT`` is literal. +For example, ``find_package(Foo)`` will search prefixes specified in the +``Foo_ROOT`` CMake variable (if set). See policy :policy:`CMP0074`. This variable may hold a single prefix or a :ref:`semicolon-separated list ` of multiple prefixes. -- cgit v0.12