diff --git a/Source/cmFindPackageCommand.cxx b/Source/cmFindPackageCommand.cxx index ef16ce85f5..0a055a2937 100644 --- a/Source/cmFindPackageCommand.cxx +++ b/Source/cmFindPackageCommand.cxx @@ -353,6 +353,29 @@ void cmFindPackageCommand::GenerateDocumentation() "variable CMAKE_DISABLE_FIND_PACKAGE_ to TRUE. See the " "documentation for the CMAKE_DISABLE_FIND_PACKAGE_ variable for " "more information.\n" + "When loading a find module or package configuration file find_package " + "defines variables to provide information about the call arguments " + "(and restores their original state before returning):\n" + " _FIND_REQUIRED = true if REQUIRED option was given\n" + " _FIND_QUIETLY = true if QUIET option was given\n" + " _FIND_VERSION = full requested version string\n" + " _FIND_VERSION_MAJOR = major version if requested, else 0\n" + " _FIND_VERSION_MINOR = minor version if requested, else 0\n" + " _FIND_VERSION_PATCH = patch version if requested, else 0\n" + " _FIND_VERSION_TWEAK = tweak version if requested, else 0\n" + " _FIND_VERSION_COUNT = number of version components, 0 to 4\n" + " _FIND_VERSION_EXACT = true if EXACT option was given\n" + " _FIND_COMPONENTS = list of requested components\n" + " _FIND_REQUIRED_ = true if component is required\n" + " false if component is optional\n" + "In Module mode the loaded find module is responsible to honor the " + "request detailed by these variables; see the find module for details. " + "In Config mode find_package handles REQUIRED, QUIET, and version " + "options automatically but leaves it to the package configuration file " + "to handle components in a way that makes sense for the package. " + "The package configuration file may set _FOUND to false " + "to tell find_package that component requirements are not satisfied." + "\n" "See the cmake_policy() command documentation for discussion of the " "NO_POLICY_SCOPE option." ;