summaryrefslogtreecommitdiff
path: root/share/cmake-3.18/Help/envvar/PackageName_ROOT.rst
diff options
context:
space:
mode:
Diffstat (limited to 'share/cmake-3.18/Help/envvar/PackageName_ROOT.rst')
-rw-r--r--share/cmake-3.18/Help/envvar/PackageName_ROOT.rst17
1 files changed, 17 insertions, 0 deletions
diff --git a/share/cmake-3.18/Help/envvar/PackageName_ROOT.rst b/share/cmake-3.18/Help/envvar/PackageName_ROOT.rst
new file mode 100644
index 0000000..82b0a06
--- /dev/null
+++ b/share/cmake-3.18/Help/envvar/PackageName_ROOT.rst
@@ -0,0 +1,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.