kolan
/
CMake
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Add documentation for the CMAKE_DISABLE_FIND_PACKAGE_<Name> switch 

Alex
This commit is contained in:
Alex Neundorf 2011-06-16 22:13:00 +02:00
parent 6e1d3edb4d
commit a66df08543
2 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
Source/cmDocumentVariables.cxx
View File

@ -718,6 +718,20 @@ void cmDocumentVariables::DefineVariables(cmake* cm)
"CMAKE_SYSTEM_PREFIX_PATH.", false,
"Variables That Change Behavior");
cm->DefineProperty
("CMAKE_DISABLE_FIND_PACKAGE_<PackageName>", cmProperty::VARIABLE,
"Variable for disabling find_package() calls.",
"Every non-REQUIRED find_package() call in a project can be disabled "
"by setting the variable CMAKE_DISABLE_FIND_PACKAGE_<PackageName> to "
"TRUE. This can be used to build a project without an optional package, "
"although that package is installed.\n"
"This switch should be used during the initial CMake run. Otherwise if "
"the package has already been found in a previous CMake run, the "
"variables which have been stored in the cache will still be there. "
"In the case it is recommended to remove the cache variables for "
"this package from the cache using the cache editor or cmake -U", false,
"Variables That Change Behavior");
cm->DefineProperty
("CMAKE_USER_MAKE_RULES_OVERRIDE", cmProperty::VARIABLE,
"Specify a CMake file that overrides platform information.",

4
Source/cmFindPackageCommand.cxx
View File

@ -335,6 +335,10 @@ void cmFindPackageCommand::GenerateDocumentation()
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"
"See the cmake_policy() command documentation for discussion of the "
"NO_POLICY_SCOPE option."
;