diff options
Diffstat (limited to 'Source/cmFindPackageCommand.cxx')
| -rw-r--r-- | Source/cmFindPackageCommand.cxx | 316 |
1 files changed, 0 insertions, 316 deletions
diff --git a/Source/cmFindPackageCommand.cxx b/Source/cmFindPackageCommand.cxx index 1d6530f..aeca39a 100644 --- a/Source/cmFindPackageCommand.cxx +++ b/Source/cmFindPackageCommand.cxx @@ -79,322 +79,6 @@ cmFindPackageCommand::cmFindPackageCommand() } //---------------------------------------------------------------------------- -void cmFindPackageCommand::GenerateDocumentation() -{ - this->cmFindCommon::GenerateDocumentation(); - cmSystemTools::ReplaceString(this->GenericDocumentationRootPath, - "CMAKE_FIND_ROOT_PATH_MODE_XXX", - "CMAKE_FIND_ROOT_PATH_MODE_PACKAGE"); - cmSystemTools::ReplaceString(this->GenericDocumentationPathsOrder, - "FIND_ARGS_XXX", "<package>"); - cmSystemTools::ReplaceString(this->GenericDocumentationPathsOrder, - "FIND_XXX", "find_package"); - this->CommandDocumentation = - " find_package(<package> [version] [EXACT] [QUIET] [MODULE]\n" - " [REQUIRED] [[COMPONENTS] [components...]]\n" - " [OPTIONAL_COMPONENTS components...]\n" - " [NO_POLICY_SCOPE])\n" - "Finds and loads settings from an external project. " - "<package>_FOUND will be set to indicate whether the package was found. " - "When the package is found package-specific information is provided " - "through variables and imported targets documented by the package " - "itself. " - "The QUIET option disables messages if the package cannot be found. " - "The MODULE option disables the second signature documented below. " - "The REQUIRED option stops processing with an error message if the " - "package cannot be found." - "\n" - "A package-specific list of required components may be listed after the " - "COMPONENTS option (or after the REQUIRED option if present). " - "Additional optional components may be listed after OPTIONAL_COMPONENTS. " - "Available components and their influence on whether a package is " - "considered to be found are defined by the target package." - "\n" - "The [version] argument requests a version with which the package found " - "should be compatible (format is major[.minor[.patch[.tweak]]]). " - "The EXACT option requests that the version be matched exactly. " - "If no [version] and/or component list is given to a recursive " - "invocation inside a find-module, the corresponding arguments " - "are forwarded automatically from the outer call (including the " - "EXACT flag for [version]). " - "Version support is currently provided only on a package-by-package " - "basis (details below).\n" - "User code should generally look for packages using the above simple " - "signature. The remainder of this command documentation specifies the " - "full command signature and details of the search process. Project " - "maintainers wishing to provide a package to be found by this command " - "are encouraged to read on.\n" - "The command has two modes by which it searches for packages: " - "\"Module\" mode and \"Config\" mode. " - "Module mode is available when the command is invoked with the above " - "reduced signature. " - "CMake searches for a file called \"Find<package>.cmake\" in " - "the CMAKE_MODULE_PATH followed by the CMake installation. " - "If the file is found, it is read and processed by CMake. " - "It is responsible for finding the package, checking the version, " - "and producing any needed messages. " - "Many find-modules provide limited or no support for versioning; " - "check the module documentation. " - "If no module is found and the MODULE option is not given the command " - "proceeds to Config mode.\n" - "The complete Config mode command signature is:\n" - " find_package(<package> [version] [EXACT] [QUIET]\n" - " [REQUIRED] [[COMPONENTS] [components...]]\n" - " [CONFIG|NO_MODULE]\n" - " [NO_POLICY_SCOPE]\n" - " [NAMES name1 [name2 ...]]\n" - " [CONFIGS config1 [config2 ...]]\n" - " [HINTS path1 [path2 ... ]]\n" - " [PATHS path1 [path2 ... ]]\n" - " [PATH_SUFFIXES suffix1 [suffix2 ...]]\n" - " [NO_DEFAULT_PATH]\n" - " [NO_CMAKE_ENVIRONMENT_PATH]\n" - " [NO_CMAKE_PATH]\n" - " [NO_SYSTEM_ENVIRONMENT_PATH]\n" - " [NO_CMAKE_PACKAGE_REGISTRY]\n" - " [NO_CMAKE_BUILDS_PATH]\n" - " [NO_CMAKE_SYSTEM_PATH]\n" - " [NO_CMAKE_SYSTEM_PACKAGE_REGISTRY]\n" - " [CMAKE_FIND_ROOT_PATH_BOTH |\n" - " ONLY_CMAKE_FIND_ROOT_PATH |\n" - " NO_CMAKE_FIND_ROOT_PATH])\n" - "The CONFIG option may be used to skip Module mode explicitly and " - "switch to Config mode. It is synonymous to using NO_MODULE. " - "Config mode is also implied by use of options not specified in the " - "reduced signature. " - "\n" - "Config mode attempts to locate a configuration file provided by the " - "package to be found. A cache entry called <package>_DIR is created to " - "hold the directory containing the file. " - "By default the command searches for a package with the name <package>. " - "If the NAMES option is given the names following it are used instead " - "of <package>. " - "The command searches for a file called \"<name>Config.cmake\" or " - "\"<lower-case-name>-config.cmake\" for each name specified. " - "A replacement set of possible configuration file names may be given " - "using the CONFIGS option. " - "The search procedure is specified below. Once found, the configuration " - "file is read and processed by CMake. Since the file is provided by the " - "package it already knows the location of package contents. " - "The full path to the configuration file is stored in the cmake " - "variable <package>_CONFIG." - "\n" - "All configuration files which have been considered by CMake while " - "searching for an installation of the package with an appropriate " - "version are stored in the cmake variable <package>_CONSIDERED_CONFIGS, " - "the associated versions in <package>_CONSIDERED_VERSIONS. " - "\n" - "If the package configuration file cannot be found CMake " - "will generate an error describing the problem unless the QUIET " - "argument is specified. If REQUIRED is specified and the package " - "is not found a fatal error is generated and the configure step stops " - "executing. If <package>_DIR has been set to a directory not containing " - "a configuration file CMake will ignore it and search from scratch." - "\n" - "When the [version] argument is given Config mode will only find a " - "version of the package that claims compatibility with the requested " - "version (format is major[.minor[.patch[.tweak]]]). " - "If the EXACT option is given only a version of the package claiming " - "an exact match of the requested version may be found. " - "CMake does not establish any convention for the meaning of version " - "numbers. " - "Package version numbers are checked by \"version\" files provided by " - "the packages themselves. " - "For a candidate package configuration file \"<config-file>.cmake\" the " - "corresponding version file is located next to it and named either " - "\"<config-file>-version.cmake\" or \"<config-file>Version.cmake\". " - "If no such version file is available then the configuration file " - "is assumed to not be compatible with any requested version. " - "A basic version file containing generic version matching code can be " - "created using the macro write_basic_package_version_file(), see its " - "documentation for more details. " - "When a version file is found it is loaded to check the requested " - "version number. " - "The version file is loaded in a nested scope in which the following " - "variables have been defined:\n" - " PACKAGE_FIND_NAME = the <package> name\n" - " PACKAGE_FIND_VERSION = full requested version string\n" - " PACKAGE_FIND_VERSION_MAJOR = major version if requested, else 0\n" - " PACKAGE_FIND_VERSION_MINOR = minor version if requested, else 0\n" - " PACKAGE_FIND_VERSION_PATCH = patch version if requested, else 0\n" - " PACKAGE_FIND_VERSION_TWEAK = tweak version if requested, else 0\n" - " PACKAGE_FIND_VERSION_COUNT = number of version components, 0 to 4\n" - "The version file checks whether it satisfies the requested version " - "and sets these variables:\n" - " PACKAGE_VERSION = full provided version string\n" - " PACKAGE_VERSION_EXACT = true if version is exact match\n" - " PACKAGE_VERSION_COMPATIBLE = true if version is compatible\n" - " PACKAGE_VERSION_UNSUITABLE = true if unsuitable as any version\n" - "These variables are checked by the find_package command to determine " - "whether the configuration file provides an acceptable version. " - "They are not available after the find_package call returns. " - "If the version is acceptable the following variables are set:\n" - " <package>_VERSION = full provided version string\n" - " <package>_VERSION_MAJOR = major version if provided, else 0\n" - " <package>_VERSION_MINOR = minor version if provided, else 0\n" - " <package>_VERSION_PATCH = patch version if provided, else 0\n" - " <package>_VERSION_TWEAK = tweak version if provided, else 0\n" - " <package>_VERSION_COUNT = number of version components, 0 to 4\n" - "and the corresponding package configuration file is loaded. " - "When multiple package configuration files are available whose version " - "files claim compatibility with the version requested it is unspecified " - "which one is chosen. " - "No attempt is made to choose a highest or closest version number." - "\n" - "Config mode provides an elaborate interface and search procedure. " - "Much of the interface is provided for completeness and for use " - "internally by find-modules loaded by Module mode. " - "Most user code should simply call\n" - " find_package(<package> [major[.minor]] [EXACT] [REQUIRED|QUIET])\n" - "in order to find a package. Package maintainers providing CMake " - "package configuration files are encouraged to name and install " - "them such that the procedure outlined below will find them " - "without requiring use of additional options." - "\n" - "CMake constructs a set of possible installation prefixes for the " - "package. Under each prefix several directories are searched for a " - "configuration file. The tables below show the directories searched. " - "Each entry is meant for installation trees following Windows (W), " - "UNIX (U), or Apple (A) conventions.\n" - " <prefix>/ (W)\n" - " <prefix>/(cmake|CMake)/ (W)\n" - " <prefix>/<name>*/ (W)\n" - " <prefix>/<name>*/(cmake|CMake)/ (W)\n" - " <prefix>/(lib/<arch>|lib|share)/cmake/<name>*/ (U)\n" - " <prefix>/(lib/<arch>|lib|share)/<name>*/ (U)\n" - " <prefix>/(lib/<arch>|lib|share)/<name>*/(cmake|CMake)/ (U)\n" - "On systems supporting OS X Frameworks and Application Bundles " - "the following directories are searched for frameworks or bundles " - "containing a configuration file:\n" - " <prefix>/<name>.framework/Resources/ (A)\n" - " <prefix>/<name>.framework/Resources/CMake/ (A)\n" - " <prefix>/<name>.framework/Versions/*/Resources/ (A)\n" - " <prefix>/<name>.framework/Versions/*/Resources/CMake/ (A)\n" - " <prefix>/<name>.app/Contents/Resources/ (A)\n" - " <prefix>/<name>.app/Contents/Resources/CMake/ (A)\n" - "In all cases the <name> is treated as case-insensitive and corresponds " - "to any of the names specified (<package> or names given by NAMES). " - "Paths with lib/<arch> are enabled if CMAKE_LIBRARY_ARCHITECTURE is set. " - "If PATH_SUFFIXES is specified the suffixes are appended to each " - "(W) or (U) directory entry one-by-one.\n" - "This set of directories is intended to work in cooperation with " - "projects that provide configuration files in their installation trees. " - "Directories above marked with (W) are intended for installations on " - "Windows where the prefix may point at the top of an application's " - "installation directory. Those marked with (U) are intended for " - "installations on UNIX platforms where the prefix is shared by " - "multiple packages. This is merely a convention, so all (W) and (U) " - "directories are still searched on all platforms. " - "Directories marked with (A) are intended for installations on " - "Apple platforms. The cmake variables CMAKE_FIND_FRAMEWORK and " - "CMAKE_FIND_APPBUNDLE determine the order of preference " - "as specified below.\n" - "The set of installation prefixes is constructed using the following " - "steps. If NO_DEFAULT_PATH is specified all NO_* options are enabled.\n" - "1. Search paths specified in cmake-specific cache variables. " - "These are intended to be used on the command line with a -DVAR=value. " - "This can be skipped if NO_CMAKE_PATH is passed.\n" - " CMAKE_PREFIX_PATH\n" - " CMAKE_FRAMEWORK_PATH\n" - " CMAKE_APPBUNDLE_PATH\n" - "2. Search paths specified in cmake-specific environment variables. " - "These are intended to be set in the user's shell configuration. " - "This can be skipped if NO_CMAKE_ENVIRONMENT_PATH is passed.\n" - " <package>_DIR\n" - " CMAKE_PREFIX_PATH\n" - " CMAKE_FRAMEWORK_PATH\n" - " CMAKE_APPBUNDLE_PATH\n" - "3. Search paths specified by the HINTS option. " - "These should be paths computed by system introspection, such as a " - "hint provided by the location of another item already found. " - "Hard-coded guesses should be specified with the PATHS option.\n" - "4. Search the standard system environment variables. " - "This can be skipped if NO_SYSTEM_ENVIRONMENT_PATH is passed. " - "Path entries ending in \"/bin\" or \"/sbin\" are automatically " - "converted to their parent directories.\n" - " PATH\n" - "5. Search project build trees recently configured in a CMake GUI. " - "This can be skipped if NO_CMAKE_BUILDS_PATH is passed. " - "It is intended for the case when a user is building multiple " - "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. " - "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 " - "is passed.\n" - " CMAKE_SYSTEM_PREFIX_PATH\n" - " CMAKE_SYSTEM_FRAMEWORK_PATH\n" - " CMAKE_SYSTEM_APPBUNDLE_PATH\n" - "8. Search paths stored in the CMake system package registry. " - "This can be skipped if NO_CMAKE_SYSTEM_PACKAGE_REGISTRY is passed. " - "On Windows a <package> may appear under registry key\n" - " HKEY_LOCAL_MACHINE\\Software\\Kitware\\CMake\\Packages\\<package>\n" - "as a REG_SZ value, with arbitrary name, that specifies the directory " - "containing the package configuration file. " - "There is no system package registry on non-Windows platforms." - "\n" - "9. Search paths specified by the PATHS option. " - "These are typically hard-coded guesses.\n" - ; - this->CommandDocumentation += this->GenericDocumentationMacPolicy; - this->CommandDocumentation += this->GenericDocumentationRootPath; - this->CommandDocumentation += this->GenericDocumentationPathsOrder; - this->CommandDocumentation += - "\n" - "Every non-REQUIRED find_package() call can be disabled by setting the " - "variable CMAKE_DISABLE_FIND_PACKAGE_<package> to TRUE. See the " - "documentation for the CMAKE_DISABLE_FIND_PACKAGE_<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" - " <package>_FIND_REQUIRED = true if REQUIRED option was given\n" - " <package>_FIND_QUIETLY = true if QUIET option was given\n" - " <package>_FIND_VERSION = full requested version string\n" - " <package>_FIND_VERSION_MAJOR = major version if requested, else 0\n" - " <package>_FIND_VERSION_MINOR = minor version if requested, else 0\n" - " <package>_FIND_VERSION_PATCH = patch version if requested, else 0\n" - " <package>_FIND_VERSION_TWEAK = tweak version if requested, else 0\n" - " <package>_FIND_VERSION_COUNT = number of version components, 0 to 4\n" - " <package>_FIND_VERSION_EXACT = true if EXACT option was given\n" - " <package>_FIND_COMPONENTS = list of requested components\n" - " <package>_FIND_REQUIRED_<c> = true if component <c> is required\n" - " false if component <c> 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 <package>_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." - ; -} - -//---------------------------------------------------------------------------- -const char* cmFindPackageCommand::GetFullDocumentation() const -{ - if(this->CommandDocumentation.empty()) - { - const_cast<cmFindPackageCommand *>(this)->GenerateDocumentation(); - } - return this->CommandDocumentation.c_str(); -} - -//---------------------------------------------------------------------------- bool cmFindPackageCommand ::InitialPass(std::vector<std::string> const& args, cmExecutionStatus &) { |