summaryrefslogtreecommitdiff
path: root/share/cmake-3.17/Help/envvar/PackageName_ROOT.rst
blob: 82b0a069e34750b168d02eac247747a48133744c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
<PackageName>_ROOT
------------------

.. include:: ENV_VAR.txt

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`.

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.