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

Docs: Update description of CMAKE_(BUILD_TYPE|CONFIGURATION_TYPES) 

Bring woefully outdated descriptions somewhat up to speed.
This commit is contained in:
Andreas Mohr 2013-05-04 16:02:21 +02:00 committed by Brad King
parent 2bab472ecb
commit 56ca34dbbd
1 changed files with 27 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
Source/cmDocumentVariables.cxx
View File

@ -577,26 +577,37 @@ void cmDocumentVariables::DefineVariables(cmake* cm)
cm->DefineProperty cm->DefineProperty
("CMAKE_CONFIGURATION_TYPES", cmProperty::VARIABLE, ("CMAKE_CONFIGURATION_TYPES", cmProperty::VARIABLE,
"Specifies the available build types.", "Specifies the available build types on multi-config generators.",
"This specifies what build types will be available such as " "This specifies what build types (configurations) will be available "
"Debug, Release, RelWithDebInfo etc. This has reasonable defaults " "such as Debug, Release, RelWithDebInfo etc. "
"on most platforms. But can be extended to provide other " "This has reasonable defaults on most platforms, "
"build types. See also CMAKE_BUILD_TYPE.", "but can be extended to provide other build types. "
false, "See also CMAKE_BUILD_TYPE for details of managing configuration data, "
"and CMAKE_CFG_INTDIR."
,false,
"Variables That Change Behavior"); "Variables That Change Behavior");
cm->DefineProperty cm->DefineProperty
("CMAKE_BUILD_TYPE", cmProperty::VARIABLE, ("CMAKE_BUILD_TYPE", cmProperty::VARIABLE,
"Specifies the build type for make based generators.", "Specifies the build type on single-configuration generators.",
"This specifies what build type will be built in this tree. " "This statically specifies what build type (configuration) "
" Possible values are empty, Debug, Release, RelWithDebInfo" "will be built in this build tree. Possible values are "
" and MinSizeRel. This variable is only supported for " "empty, Debug, Release, RelWithDebInfo and MinSizeRel. "
"make based generators. If this variable is supported, " "This variable is only meaningful to single-configuration generators "
"then CMake will also provide initial values for the " "(such as make and Ninja) i.e. "
"variables with the name " "those which choose a single configuration "
" CMAKE_C_FLAGS_[DEBUG|RELEASE|RELWITHDEBINFO|MINSIZEREL]." "when CMake runs to generate a build tree as opposed to "
" For example, if CMAKE_BUILD_TYPE is Debug, then " "multi-configuration generators which offer selection of the build "
"CMAKE_C_FLAGS_DEBUG will be added to the CMAKE_C_FLAGS.",false, "configuration within the generated build environment. "
"There are many per-config properties and variables "
"(usually following clean SOME_VAR_<CONFIG> order conventions), "
"such as CMAKE_C_FLAGS_<CONFIG>, specified as uppercase: "
"CMAKE_C_FLAGS_[DEBUG|RELEASE|RELWITHDEBINFO|MINSIZEREL]. "
"For example, in a build tree configured "
"to build type Debug, CMake will see to having "
"CMAKE_C_FLAGS_DEBUG settings get added to the CMAKE_C_FLAGS settings. "
"See also CMAKE_CONFIGURATION_TYPES."
,false,
"Variables That Change Behavior"); "Variables That Change Behavior");
cm->DefineProperty cm->DefineProperty