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/command/find_package.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/command/find_package.rst')
| -rw-r--r-- | Help/command/find_package.rst | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/Help/command/find_package.rst b/Help/command/find_package.rst index 53f3819..a4416ab 100644 --- a/Help/command/find_package.rst +++ b/Help/command/find_package.rst @@ -262,8 +262,10 @@ The set of installation prefixes is constructed using the following steps. If ``NO_DEFAULT_PATH`` is specified all ``NO_*`` options are enabled. -1. Search paths specified in the ``PackageName_ROOT`` CMake and environment - variables. The package root variables are maintained as a stack so if +1. Search paths specified in the :variable:`<PackageName>_ROOT` CMake + variable and the :envvar:`<PackageName>_ROOT` environment variable, + where ``<PackageName>`` is the package to be found. + The package root variables are maintained as a stack so if called from within a find module, root paths from the parent's find module will also be searched after paths for the current package. This can be skipped if ``NO_PACKAGE_ROOT_PATH`` is passed. |