mirror/CMake
1
0
Fork 0
mirror of https://github.com/Kitware/CMake.git synced 2026-05-04 05:10:10 -05:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source 
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
Download Patch File Download Diff File Expand all files Collapse all files
Help/command/find_package.rst
+2 -1
View File
@@ -370,7 +370,8 @@ enabled.
1. .. versionadded:: 3.12 1. .. versionadded:: 3.12
Search paths specified in the :variable:`<PackageName>_ROOT` CMake Search paths specified in the :variable:`<PackageName>_ROOT` CMake
variable and the :envvar:`<PackageName>_ROOT` environment variable, 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 The package root variables are maintained as a stack so if
called from within a find module, root paths from the parent's find called from within a find module, root paths from the parent's find
module will also be searched after paths for the current package. module will also be searched after paths for the current package.
Help/envvar/PackageName_ROOT.rst
+4 -4
View File
@@ -7,10 +7,10 @@
Calls to :command:`find_package(<PackageName>)` will search in prefixes Calls to :command:`find_package(<PackageName>)` will search in prefixes
specified by the ``<PackageName>_ROOT`` environment variable, where specified by the ``<PackageName>_ROOT`` environment variable, where
``<PackageName>`` is the name given to the :command:`find_package` call ``<PackageName>`` is the (case-preserved) name given to the
and ``_ROOT`` is literal. For example, ``find_package(Foo)`` will search :command:`find_package` call and ``_ROOT`` is literal.
prefixes specified in the ``Foo_ROOT`` environment variable (if set). For example, ``find_package(Foo)`` will search prefixes specified in the
See policy :policy:`CMP0074`. ``Foo_ROOT`` environment variable (if set). See policy :policy:`CMP0074`.
This variable may hold a single prefix or a list of prefixes separated 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 by ``:`` on UNIX or ``;`` on Windows (the same as the ``PATH`` environment
Help/variable/PackageName_ROOT.rst
+4 -4
View File
@@ -5,10 +5,10 @@
Calls to :command:`find_package(<PackageName>)` will search in prefixes Calls to :command:`find_package(<PackageName>)` will search in prefixes
specified by the ``<PackageName>_ROOT`` CMake variable, where specified by the ``<PackageName>_ROOT`` CMake variable, where
``<PackageName>`` is the name given to the :command:`find_package` call ``<PackageName>`` is the (case-preserved) name given to the
and ``_ROOT`` is literal. For example, ``find_package(Foo)`` will search :command:`find_package` call and ``_ROOT`` is literal.
prefixes specified in the ``Foo_ROOT`` CMake variable (if set). For example, ``find_package(Foo)`` will search prefixes specified in the
See policy :policy:`CMP0074`. ``Foo_ROOT`` CMake variable (if set). See policy :policy:`CMP0074`.
This variable may hold a single prefix or a This variable may hold a single prefix or a
:ref:`semicolon-separated list <CMake Language Lists>` of multiple prefixes. :ref:`semicolon-separated list <CMake Language Lists>` of multiple prefixes.