Merge topic 'doc-deprecation-variables'

c64326b Document some variables for deprecation control.
This commit is contained in:
Brad King 2013-07-15 09:43:06 -04:00 committed by CMake Topic Stage
commit b94e726a83
1 changed files with 24 additions and 0 deletions

View File

@ -514,6 +514,13 @@ void cmDocumentVariables::DefineVariables(cmake* cm)
"analysis of libraries linked by a target.", "analysis of libraries linked by a target.",
false, false,
"Variables that Provide Information"); "Variables that Provide Information");
cm->DefineProperty
("CMAKE_MINIMUM_REQUIRED_VERSION", cmProperty::VARIABLE,
"Version specified to cmake_minimum_required command",
"Variable containing the VERSION component specified in the "
"cmake_minimum_required command.",
false,
"Variables that Provide Information");
// Variables defined by cmake, that change the behavior // Variables defined by cmake, that change the behavior
@ -677,6 +684,23 @@ void cmDocumentVariables::DefineVariables(cmake* cm)
false, false,
"Variables That Change Behavior"); "Variables That Change Behavior");
cm->DefineProperty
("CMAKE_WARN_DEPRECATED", cmProperty::VARIABLE,
"Whether to issue deprecation warnings for macros and functions.",
"If TRUE, this can be used by macros and functions to issue "
"deprecation warnings. This variable is FALSE by default.",
false,
"Variables That Change Behavior");
cm->DefineProperty
("CMAKE_ERROR_DEPRECATED", cmProperty::VARIABLE,
"Whether to issue deprecation errors for macros and functions.",
"If TRUE, this can be used by macros and functions to issue "
"fatal errors when deprecated macros or functions are used. This "
"variable is FALSE by default.",
false,
"Variables That Change Behavior");
cm->DefineProperty cm->DefineProperty
("CMAKE_PREFIX_PATH", cmProperty::VARIABLE, ("CMAKE_PREFIX_PATH", cmProperty::VARIABLE,
"Path used for searching by FIND_XXX(), with appropriate suffixes added.", "Path used for searching by FIND_XXX(), with appropriate suffixes added.",