find_package: Document user package registry locations

Specify the Windows registry key under HKEY_CURRENT_USER and directory
on UNIX platforms in which the package registry is stored.

1 files changed, 10 insertions, 3 deletions

diff --git a/Source/cmFindPackageCommand.cxx b/Source/cmFindPackageCommand.cxx
index d2d3956..5cc5683 100644
--- a/Source/cmFindPackageCommand.cxx
+++ b/Source/cmFindPackageCommand.cxx
@@ -299,9 +299,16 @@ void cmFindPackageCommand::GenerateDocumentation()
     "dependent projects one after another.\n"
     "6. Search paths stored in the CMake user package registry.  "
     "This can be skipped if NO_CMAKE_PACKAGE_REGISTRY is passed.  "
-    "Paths are stored in the registry when CMake configures a project "
-    "that invokes export(PACKAGE <name>).  "
-    "See the export(PACKAGE) command documentation for more details."
+    "On Windows a <package> may appear under registry key\n"
+    "  HKEY_CURRENT_USER\\Software\\Kitware\\CMake\\Packages\\<package>\n"
+    "as a REG_SZ value, with arbitrary name, that specifies the directory "
+    "containing the package configuration file.  "
+    "On UNIX platforms a <package> may appear under the directory\n"
+    "  ~/.cmake/packages/<package>\n"
+    "as a file, with arbitrary name, whose content specifies the directory "
+    "containing the package configuration file.  "
+    "See the export(PACKAGE) command to create user package registry entries "
+    "for project build trees."
     "\n"
     "7. Search cmake variables defined in the Platform files "
     "for the current system.  This can be skipped if NO_CMAKE_SYSTEM_PATH "