diff options
| author | Brad King <brad.king@kitware.com> | 2023-02-09 15:01:41 (GMT) |
|---|---|---|
| committer | Kitware Robot <kwrobot@kitware.com> | 2023-02-09 15:01:52 (GMT) |
| commit | df314006489572b5a7e587c529e48f22e5d4ffa0 (patch) | |
| tree | 5c357833581cdb55fd9fa10a30c83b5bc5577ec2 | |
| parent | 53cdc5aa30261c3ced1fe47a326b6ad90f57e612 (diff) | |
| parent | 20e727a408deeac7a6b0b27c729f4d27fc7cc43a (diff) | |
| download | CMake-df314006489572b5a7e587c529e48f22e5d4ffa0.zip CMake-df314006489572b5a7e587c529e48f22e5d4ffa0.tar.gz CMake-df314006489572b5a7e587c529e48f22e5d4ffa0.tar.bz2 | |
Merge topic 'doc-find_package-root-case'
20e727a408 Help: Clarify that <PackageName>_ROOT variable names are case-preserved
Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !8182
| -rw-r--r-- | Help/command/find_package.rst | 3 | ||||
| -rw-r--r-- | Help/envvar/PackageName_ROOT.rst | 8 | ||||
| -rw-r--r-- | 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:`<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. 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(<PackageName>)` will search in prefixes specified by the ``<PackageName>_ROOT`` environment variable, where -``<PackageName>`` 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`. +``<PackageName>`` 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(<PackageName>)` will search in prefixes specified by the ``<PackageName>_ROOT`` CMake variable, where -``<PackageName>`` 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`. +``<PackageName>`` 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 <CMake Language Lists>` of multiple prefixes. |