diff options
author | Brad King <brad.king@kitware.com> | 2018-07-19 18:19:42 (GMT) |
---|---|---|
committer | Brad King <brad.king@kitware.com> | 2018-07-20 13:43:08 (GMT) |
commit | 492ade276b9a54ad61ba5eed4eea77897fdb74c1 (patch) | |
tree | d4eacdf430e9e29aa89244e2ab1dd9c01ba5ab78 /Help/variable/PackageName_ROOT.rst | |
parent | f84c15ef2fa30dd074fcccafccec6b9b69266619 (diff) | |
download | CMake-492ade276b9a54ad61ba5eed4eea77897fdb74c1.zip CMake-492ade276b9a54ad61ba5eed4eea77897fdb74c1.tar.gz CMake-492ade276b9a54ad61ba5eed4eea77897fdb74c1.tar.bz2 |
Help: Add explicit <PackageName>_ROOT variable documentation
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.
Diffstat (limited to 'Help/variable/PackageName_ROOT.rst')
-rw-r--r-- | Help/variable/PackageName_ROOT.rst | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/Help/variable/PackageName_ROOT.rst b/Help/variable/PackageName_ROOT.rst new file mode 100644 index 0000000..4f6c25b --- /dev/null +++ b/Help/variable/PackageName_ROOT.rst @@ -0,0 +1,14 @@ +<PackageName>_ROOT +------------------ + +Calls to :command:`find_package(<PackageName>)` will search in prefixes +specified by the ``<PackageName>_ROOT`` CMake 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`` CMake variable (if set). +See policy :policy:`CMP0074`. + +This variable may hold a single prefix or a +:ref:`;-list <CMake Language Lists>` of multiple prefixes. + +See also the :envvar:`<PackageName>_ROOT` environment variable. |