Browse Source

Merge topic 'doc-find-root-dir'

b431306f22 Help: Clarify the Xxx_ROOT_DIR

Acked-by: Kitware Robot <[email protected]>
Acked-by: Alex <[email protected]>
Merge-request: !10006
Brad King 11 months ago
parent
commit
908b2ca27c
1 changed files with 5 additions and 1 deletions
  1. 5 1
      Help/manual/cmake-developer.7.rst

+ 5 - 1
Help/manual/cmake-developer.7.rst

@@ -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