CMake/Help/envvar/PackageName_ROOT.rst
Joachim Wuttke (l) 26a70449cc Help: Describe environment variables as such.
In each environment variable doc page, insert an opening
paragraph (ENV_VAR.txt) to say that this is an environment
variable, and provide a link to the cmake-language section
on environment variables.
2018-11-13 09:29:36 +01:00

18 lines
693 B
ReStructuredText

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