diff options
| author | Craig Scott <craig.scott@crascit.com> | 2018-07-20 22:58:14 (GMT) |
|---|---|---|
| committer | Kitware Robot <kwrobot@kitware.com> | 2018-07-20 22:58:43 (GMT) |
| commit | e3664debd2d950de1b0d0a0c673ada05ae9a700d (patch) | |
| tree | af4be391aa3f6809978b69b680b08f5836ce2b62 /Help/variable | |
| parent | 01c04e429717fb7a6a157ce1baeb2114724ec055 (diff) | |
| parent | 492ade276b9a54ad61ba5eed4eea77897fdb74c1 (diff) | |
| download | CMake-e3664debd2d950de1b0d0a0c673ada05ae9a700d.zip CMake-e3664debd2d950de1b0d0a0c673ada05ae9a700d.tar.gz CMake-e3664debd2d950de1b0d0a0c673ada05ae9a700d.tar.bz2 | |
Merge topic 'doc-find_package-root'
492ade276b Help: Add explicit <PackageName>_ROOT variable documentation
Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !2225
Diffstat (limited to 'Help/variable')
| -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. |