mirror of
https://github.com/Kitware/CMake.git
synced 2026-02-06 15:19:56 -06:00
492ade276b
Add documentation for both the CMake variable and environment variable of this name pattern. Update references to these names to link to their documents. Clarify the pattern used to construct their names.
16 lines
667 B
ReStructuredText
16 lines
667 B
ReStructuredText
<PackageName>_ROOT
|
|
------------------
|
|
|
|
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 ``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
|
|
variable convention on those platforms).
|
|
|
|
See also the :variable:`<PackageName>_ROOT` CMake variable.
|