Kitware/CMake
1
0
Fork 0
mirror of https://github.com/Kitware/CMake.git synced 2025-10-23 18:08:31 +08:00
Code Issues Projects Releases Wiki Activity

Help: Clarify the Xxx_ROOT_DIR

Browse Source 
The Xxx_ROOT_DIR is optional result variable set by find module when
package is found. It is the base directory of the Xxx installation. The
`Xxx_ROOT` is a hint variable set by the user where to look for the
`Xxx` package.
This commit is contained in:
Peter Kokot
2024-11-16 21:51:43 +01:00
parent a8bdbf748f
commit b431306f22
1 changed files with 5 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
Help/manual/cmake-developer.7.rst
View File

@@ -216,7 +216,11 @@ for any macros, functions and imported targets defined by the Find module.
variable for use by client code. This should not be a cache entry.
``Xxx_ROOT_DIR``
Where to find the base directory of the module.
The base directory of the installation of ``Xxx`` that can be optionally set
by the find module if ``Xxx`` is found. This is useful for large packages
where many files need to be referenced relative to a common base (or root)
directory. Not to be confused with the ``Xxx_ROOT`` hint variable set from the
outside for the find module to know where to look for the ``Xxx``.
``Xxx_VERSION_VV``
Variables of this form specify whether the ``Xxx`` module being provided