cmDocumentVariables.cxx 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593
  1. #include "cmDocumentVariables.h"
  2. #include "cmake.h"
  3. void cmDocumentVariables::DefineVariables(cmake* cm)
  4. {
  5. // Subsection: variables defined by cmake, that give
  6. // information about the project, and cmake
  7. cm->DefineProperty
  8. ("CMAKE_COMMAND", cmProperty::VARIABLE,
  9. "The full path to the cmake executable.",
  10. "This is the full path to the CMake executable cmake which is "
  11. "useful from custom commands that want to use the cmake -E "
  12. "option for portable system commands. "
  13. "(e.g. /usr/local/bin/cmake", false,
  14. "Variables that Provide Information");
  15. cm->DefineProperty
  16. ("CMAKE_BINARY_DIR", cmProperty::VARIABLE,
  17. "The path to the top level of the build tree.",
  18. "This is the full path to the top level of the current CMake "
  19. "build tree. For an in-source build, this would be the same "
  20. "as CMAKE_SOURCE_DIR. ", false,
  21. "Variables that Provide Information");
  22. cm->DefineProperty
  23. ("CMAKE_SOURCE_DIR", cmProperty::VARIABLE,
  24. "The path to the top level of the source tree.",
  25. "This is the full path to the top level of the current CMake "
  26. "source tree. For an in-source build, this would be the same "
  27. "as CMAKE_BINARY_DIR. ", false,
  28. "Variables that Provide Information");
  29. cm->DefineProperty
  30. ("CMAKE_CURRENT_BINARY_DIR", cmProperty::VARIABLE,
  31. "The path to the binary directory currently being processed.",
  32. "This the full path to the build directory that is currently "
  33. "being processed by cmake. Each directory added by "
  34. "add_subdirectory will create a binary directory in the build "
  35. "tree, and as it is being processed this variable will be set. "
  36. "For in-source builds this is the current source directory "
  37. "being processed.", false,
  38. "Variables that Provide Information");
  39. cm->DefineProperty
  40. ("CMAKE_CURRENT_SOURCE_DIR", cmProperty::VARIABLE,
  41. "The path to the source directory currently being processed.",
  42. "This the full path to the source directory that is currently "
  43. "being processed by cmake. ", false,
  44. "Variables that Provide Information");
  45. cm->DefineProperty
  46. ("CMAKE_CURRENT_LIST_FILE", cmProperty::VARIABLE,
  47. "The path to the file currently being processed.",
  48. "This the full path to the file that is currently "
  49. "being processed by cmake. ", false,
  50. "Variables that Provide Information");
  51. cm->DefineProperty
  52. ("CMAKE_CURRENT_LIST_LINE", cmProperty::VARIABLE,
  53. "The line number of the current file being processed.",
  54. "This is the line number of the file currently being"
  55. " processed by cmake.", false,
  56. "Variables that Provide Information");
  57. cm->DefineProperty
  58. ("CMAKE_BUILD_TOOL", cmProperty::VARIABLE,
  59. "Tool used for the acutal build process.",
  60. "This variable is set to the program that will be"
  61. " needed to build the output of CMake. If the "
  62. "generator selected was Visual Studio 6, the "
  63. "CMAKE_MAKE_PROGRAM will be set to msdev, for "
  64. "Unix makefiles it will be set to make or gmake, "
  65. "and for Visual Studio 7 it set to devenv. For "
  66. "Nmake Makefiles the value is nmake. This can be "
  67. "useful for adding special flags and commands based"
  68. " on the final build environment. ", false,
  69. "Variables that Provide Information");
  70. cm->DefineProperty
  71. ("CMAKE_CACHEFILE_DIR", cmProperty::VARIABLE,
  72. "The directory with the CMakeCache.txt file.",
  73. "This is the full path to the directory that has the "
  74. "CMakeCache.txt file in it. This is the same as "
  75. "CMAKE_BINARY_DIR.", false,
  76. "Variables that Provide Information");
  77. cm->DefineProperty
  78. ("CMAKE_CACHE_MAJOR_VERSION", cmProperty::VARIABLE,
  79. "Major version of CMake used to create the CMakeCache.txt file",
  80. "This is stores the major version of CMake used to "
  81. "write a CMake cache file. It is only different when "
  82. "a different version of CMake is run on a previously "
  83. "created cache file.", false,
  84. "Variables that Provide Information");
  85. cm->DefineProperty
  86. ("CMAKE_CACHE_MINOR_VERSION", cmProperty::VARIABLE,
  87. "Minor version of CMake used to create the CMakeCache.txt file",
  88. "This is stores the minor version of CMake used to "
  89. "write a CMake cache file. It is only different when "
  90. "a different version of CMake is run on a previously "
  91. "created cache file.", false,
  92. "Variables that Provide Information");
  93. cm->DefineProperty
  94. ("CMAKE_CACHE_RELEASE_VERSION", cmProperty::VARIABLE,
  95. "Release version of CMake used to create the CMakeCache.txt file",
  96. "This is stores the release version of CMake used to "
  97. "write a CMake cache file. It is only different when "
  98. "a different version of CMake is run on a previously "
  99. "created cache file.", false,
  100. "Variables that Provide Information");
  101. cm->DefineProperty
  102. ("CMAKE_CFG_INTDIR", cmProperty::VARIABLE,
  103. "Build time configuration directory for project.",
  104. "This is a variable that is used to provide developers"
  105. " access to the intermediate directory used by Visual "
  106. "Studio IDE projects. For example, if building "
  107. "Debug all executables and libraries end up in a "
  108. "Debug directory. On UNIX systems this variable "
  109. "is set to \".\". However, with Visual Studio this "
  110. "variable is set to $(IntDir). $(IntDir) is expanded "
  111. "by the IDE only. So this variable should only be "
  112. "used in custom commands that will be run during "
  113. "the build process. This variable should not be "
  114. "used directly in a CMake command. CMake has no "
  115. "way of knowing if Debug or Release will be picked "
  116. "by the IDE for a build type. If a program needs to "
  117. "know the directory it was built in, it can use "
  118. "CMAKE_INTDIR. CMAKE_INTDIR is a C/C++ preprocessor "
  119. "macro that is defined on the command line of the "
  120. "compiler. If it has a value, it will be the "
  121. "intermediate directory used to build the file. "
  122. "This way an executable or a library can find files "
  123. "that are located in the build directory.",false,
  124. "Variables that Provide Information");
  125. cm->DefineProperty
  126. ("CMAKE_CTEST_COMMAND", cmProperty::VARIABLE,
  127. "Full path to ctest command installed with cmake.",
  128. "This is the full path to the CTest executable ctest "
  129. "which is useful from custom commands that want "
  130. " to use the cmake -E option for portable system "
  131. "commands.",false,
  132. "Variables that Provide Information");
  133. cm->DefineProperty
  134. ("CMAKE_DL_LIBS", cmProperty::VARIABLE,
  135. "Name of library containing dlopen and dlcose.",
  136. "The name of the library that has dlopen and "
  137. "dlclose in it, usually -ldl on most UNIX machines.",false,
  138. "Variables that Provide Information");
  139. cm->DefineProperty
  140. ("CMAKE_EDIT_COMMAND", cmProperty::VARIABLE,
  141. "Full path to CMakeSetup or ccmake.",
  142. "This is the full path to the CMake executable "
  143. "that can graphically edit the cache. For example,"
  144. " CMakeSetup, ccmake, or cmake -i.",false,
  145. "Variables that Provide Information");
  146. cm->DefineProperty
  147. ("CMAKE_GENERATOR", cmProperty::VARIABLE,
  148. "The generator used to build the project.",
  149. "The name of the generator that is being used to generate the "
  150. "build files. (e.g. \"Unix Makefiles\", "
  151. "\"Visual Studio 6\", etc.)",false,
  152. "Variables that Provide Information");
  153. cm->DefineProperty
  154. ("CMAKE_HOME_DIRECTORY", cmProperty::VARIABLE,
  155. "Path to top of source tree.",
  156. "This is the path to the top level of the source tree.",false,
  157. "Variables that Provide Information");
  158. cm->DefineProperty
  159. ("CMAKE_LINK_LIBRARY_SUFFIX", cmProperty::VARIABLE,
  160. "The suffix for libraries that you link to.",
  161. "The suffix to use for the end of a library, .lib on Windows.",false,
  162. "Variables that Provide Information");
  163. cm->DefineProperty
  164. ("CMAKE_MAJOR_VERSION", cmProperty::VARIABLE,
  165. "The Major version of cmake (i.e. the 2 in 2.X.X)",
  166. "This specifies the major version of the CMake executable"
  167. " being run.",false,
  168. "Variables that Provide Information");
  169. cm->DefineProperty
  170. ("CMAKE_MAKE_PROGRAM", cmProperty::VARIABLE,
  171. "See CMAKE_BUILD_TOOL.",
  172. "This variable is around for backwards compatibility, "
  173. "see CMAKE_BUILD_TOOL.",false,
  174. "Variables that Provide Information");
  175. cm->DefineProperty
  176. ("CMAKE_MINOR_VERSION", cmProperty::VARIABLE,
  177. "The Minor version of cmake (i.e. the 4 in X.4.X).",
  178. "This specifies the minor version of the CMake"
  179. " executable being run.",false,
  180. "Variables that Provide Information");
  181. cm->DefineProperty
  182. ("CMAKE_PROJECT_NAME", cmProperty::VARIABLE,
  183. "The name of the current project.",
  184. "This specifies name of the current project from"
  185. " the closest inherited PROJECT command.",false,
  186. "Variables that Provide Information");
  187. cm->DefineProperty
  188. ("CMAKE_RANLIB", cmProperty::VARIABLE,
  189. "Name of randomizing tool for static libraries.",
  190. "This specifies name of the program that randomizes "
  191. "libraries on UNIX, not used on Windows, but may be present.",false,
  192. "Variables that Provide Information");
  193. cm->DefineProperty
  194. ("CMAKE_ROOT", cmProperty::VARIABLE,
  195. "Install directory for running cmake.",
  196. "This is the install root for the running CMake and"
  197. " the Modules directory can be found here. This is"
  198. " commonly used in this format: ${CMAKE_ROOT}/Modules",false,
  199. "Variables that Provide Information");
  200. cm->DefineProperty
  201. ("CMAKE_SIZEOF_VOID_P", cmProperty::VARIABLE,
  202. "Size of a void pointer.",
  203. "This is set to the size of a pointer on the machine, "
  204. "and is determined by a try compile. If a 64 bit size "
  205. "is found, then the library search path is modified to "
  206. "look for 64 bit libraries first.",false,
  207. "Variables that Provide Information");
  208. cm->DefineProperty
  209. ("CMAKE_SKIP_RPATH", cmProperty::VARIABLE,
  210. "If true, do not add run time path information.",
  211. "If this is set to TRUE, then the rpath information "
  212. "is not added to compiled executables. The default"
  213. "is to add rpath information if the platform supports it."
  214. "This allows for easy running from the build tree.",false,
  215. "Variables that Provide Information");
  216. cm->DefineProperty
  217. ("CMAKE_SOURCE_DIR", cmProperty::VARIABLE,
  218. "Source directory for project.",
  219. "This is the top level source directory for the project. "
  220. "It corresponds to the source directory given to "
  221. "CMakeSetup or ccmake.",false,
  222. "Variables that Provide Information");
  223. cm->DefineProperty
  224. ("CMAKE_STANDARD_LIBRARIES", cmProperty::VARIABLE,
  225. "Libraries linked into every executable and shared library.",
  226. "This is the list of libraries that are linked "
  227. "into all executables and libraries.",false,
  228. "Variables that Provide Information");
  229. cm->DefineProperty
  230. ("CMAKE_USING_VC_FREE_TOOLS", cmProperty::VARIABLE,
  231. "True if free visual studio tools being used.",
  232. "This is set to true if the compiler is Visual "
  233. "Studio free tools.",false,
  234. "Variables that Provide Information");
  235. cm->DefineProperty
  236. ("CMAKE_VERBOSE_MAKEFILE", cmProperty::VARIABLE,
  237. "Create verbose makefiles if on.",
  238. "This variable defaults to false. You can set "
  239. "this variable to true to make CMake produce verbose "
  240. "makefiles that show each command line as it is used.",false,
  241. "Variables that Provide Information");
  242. cm->DefineProperty
  243. ("PROJECT_BINARY_DIR", cmProperty::VARIABLE,
  244. "Full path to build directory for project.",
  245. "This is the binary directory of the most recent "
  246. "PROJECT command.",false,"Variables that Provide Information");
  247. cm->DefineProperty
  248. ("PROJECT_NAME", cmProperty::VARIABLE,
  249. "Name of the project given to the project command.",
  250. "This is the name given to the most "
  251. "recent PROJECT command. ",false,
  252. "Variables that Provide Information");
  253. cm->DefineProperty
  254. ("PROJECT_SOURCE_DIR", cmProperty::VARIABLE,
  255. "Top level source directory for the current project.",
  256. "This is the source directory of the most recent "
  257. "PROJECT command.",false,
  258. "Variables that Provide Information");
  259. cm->DefineProperty
  260. ("[Project name]_BINARY_DIR", cmProperty::VARIABLE,
  261. "Top level binary directory for the named project.",
  262. "A variable is created with the name used in the PROJECT "
  263. "command, and is the binary directory for the project. "
  264. " This can be useful when SUBDIR is used to connect "
  265. "several projects.",false,
  266. "Variables that Provide Information");
  267. cm->DefineProperty
  268. ("[Project name]_SOURCE_DIR", cmProperty::VARIABLE,
  269. "Top level source directory for the named project.",
  270. "A variable is created with the name used in the PROJECT "
  271. "command, and is the source directory for the project."
  272. " This can be useful when add_subdirectory "
  273. "is used to connect several projects.",false,
  274. "Variables that Provide Information");
  275. // Variables defined by cmake, that change the behavior
  276. // of cmake
  277. cm->DefineProperty
  278. ("CMAKE_BUILD_TYPE", cmProperty::VARIABLE,
  279. "Specifies the build type for make based generators.",
  280. "This specifies what build type will be built in this tree. "
  281. " Possible values are empty, Debug, Release, RelWithDebInfo"
  282. " and MinSizeRel. This variable is only supported for "
  283. "make based generators. If this variable is supported, "
  284. "then CMake will also provide initial values for the "
  285. "variables with the name "
  286. " CMAKE_C_FLAGS_[Debug|Release|RelWithDebInfo|MinSizeRel]."
  287. " For example, if CMAKE_BUILD_TYPE is Debug, then "
  288. "CMAKE_C_FLAGS_DEBUG will be added to the CMAKE_C_FLAGS.",false,
  289. "Variables That Change Behavior");
  290. cm->DefineProperty
  291. ("CMAKE_BACKWARDS_COMPATIBILITY", cmProperty::VARIABLE,
  292. "Version of cmake required to build project",
  293. "From the point of view of backwards compatibility, this "
  294. "specifies what version of CMake should be supported. By "
  295. "default this value is the version number of CMake that "
  296. "you are running. You can set this to an older version of"
  297. " CMake to support deprecated commands of CMake in projects"
  298. " that were written to use older versions of CMake. This "
  299. "can be set by the user or set at the beginning of a "
  300. "CMakeLists file.",false,
  301. "Variables That Change Behavior");
  302. cm->DefineProperty
  303. ("CMAKE_INSTALL_PREFIX", cmProperty::VARIABLE,
  304. "Install directory used by install.",
  305. "If \"make install\" is invoked or INSTALL is built"
  306. ", this directory is pre-pended onto all install "
  307. "directories. This variable defaults to /usr/local"
  308. " on UNIX and c:/Program Files on Windows.",false,
  309. "Variables That Change Behavior");
  310. cm->DefineProperty
  311. ("CMAKE_USER_MAKE_RULES_OVERRIDE", cmProperty::VARIABLE,
  312. "Specify a file that can change the build rule variables.",
  313. "If this variable is set, it should to point to a "
  314. "CMakeLists.txt file that will be read in by CMake "
  315. "after all the system settings have been set, but "
  316. "before they have been used. This would allow you "
  317. "to override any variables that need to be changed "
  318. "for some special project. ",false,
  319. "Variables That Change Behavior");
  320. cm->DefineProperty
  321. ("BUILD_SHARED_LIBS", cmProperty::VARIABLE,
  322. "Global flag to cause add_library to create shared libraries if on.",
  323. "If present and true, this will cause all libraries to be "
  324. "built shared unless the library was explicitly added as a "
  325. "static library. This variable is often added to projects "
  326. "as an OPTION so that each user of a project can decide if "
  327. "they want to build the project using shared or static "
  328. "libraries.",false,
  329. "Variables That Change Behavior");
  330. cm->DefineProperty
  331. ("CMAKE_NOT_USING_CONFIG_FLAGS", cmProperty::VARIABLE,
  332. "Skip _BUILD_TYPE flags if true.",
  333. "This is an internal flag used by the generators in "
  334. "CMake to tell CMake to skip the _BUILD_TYPE flags.",false,
  335. "Variables That Change Behavior");
  336. cm->DefineProperty
  337. ("CMAKE_MFC_FLAG", cmProperty::VARIABLE,
  338. "Tell cmake to use MFC for an executable or dll.",
  339. "This can be set in a CMakeLists.txt file and will "
  340. "enable MFC in the application. It should be set "
  341. "to 1 for static the static MFC library, and 2 for "
  342. "the shared MFC library. This is used in visual "
  343. "studio 6 and 7 project files. The CMakeSetup "
  344. "dialog uses MFC and the CMakeLists.txt looks like this:\n"
  345. "ADD_DEFINITIONS(-D_AFXDLL)\n"
  346. "set(CMAKE_MFC_FLAG 2)\n"
  347. "add_executable(CMakeSetup WIN32 ${SRCS})\n",false,
  348. "Variables That Change Behavior");
  349. // Variables defined by CMake that describe the system
  350. cm->DefineProperty
  351. ("CMAKE_SYSTEM", cmProperty::VARIABLE,
  352. "Name of system cmake is being run on.",
  353. "This variable is the composite of CMAKE_SYSTEM_NAME"
  354. "and CMAKE_SYSTEM_VERSION, like this "
  355. "${CMAKE_SYSTEM_NAME}-${CMAKE_SYSTEM_VERSION}. "
  356. "If CMAKE_SYSTEM_VERSION is not set, then "
  357. "CMAKE_SYSTEM is the same as CMAKE_SYSTEM_NAME.",false,
  358. "Variables That Describe the System");
  359. cm->DefineProperty
  360. ("CMAKE_SYSTEM_NAME", cmProperty::VARIABLE,
  361. "Name of the OS CMake is running on.",
  362. "This is the name of the operating system on "
  363. "which CMake is running. On systems that "
  364. "have the uname command, this variable is set "
  365. "to the output of uname -s. Linux, Windows, "
  366. " and Darwin for Mac OSX are the values found "
  367. " on the big three operating systems." ,false,
  368. "Variables That Describe the System");
  369. cm->DefineProperty
  370. ("CMAKE_SYSTEM_PROCESSOR", cmProperty::VARIABLE,
  371. "The name of the CPU CMake is running on.",
  372. "On systems that support uname, this variable is "
  373. "set to the output of uname -p, on windows it is "
  374. "set to the value of the environment variable "
  375. "PROCESSOR_ARCHITECTURE",false,
  376. "Variables That Describe the System");
  377. cm->DefineProperty
  378. ("CMAKE_SYSTEM_VERSION", cmProperty::VARIABLE,
  379. "OS version.",
  380. "A numeric version string for the system, on "
  381. "systems that support uname, this variable is "
  382. "set to the output of uname -r. On other "
  383. "systems this is set to major-minor version numbers.",false,
  384. "Variables That Describe the System");
  385. cm->DefineProperty
  386. ("APPLE", cmProperty::VARIABLE,
  387. "True if running on Mac OSX.",
  388. "Set to true on Mac OSX.",false,
  389. "Variables That Describe the System");
  390. cm->DefineProperty
  391. ("BORLAND", cmProperty::VARIABLE,
  392. "True of the borland compiler is being used.",
  393. "This is set to true if the Borland compiler is being used.",false,
  394. "Variables That Describe the System");
  395. cm->DefineProperty
  396. ("CYGWIN", cmProperty::VARIABLE,
  397. "True for cygwin.",
  398. "Set to true when using CYGWIN.",false,
  399. "Variables That Describe the System");
  400. cm->DefineProperty
  401. ("UNIX", cmProperty::VARIABLE,
  402. "True for UNIX and UNIX like operating systems.",
  403. "Set to true when the system is UNIX or UNIX like "
  404. "(i.e. APPLE and CYGWIN).",false,
  405. "Variables That Describe the System");
  406. cm->DefineProperty
  407. ("WIN32", cmProperty::VARIABLE,
  408. "Tru on windows systems, including win64.",
  409. "Set to true when the system is Windows and on cygwin.",false,
  410. "Variables That Describe the System");
  411. // Variables that affect the building of object files and
  412. // targets.
  413. //
  414. cm->DefineProperty
  415. ("CMAKE_EXE_LINKER_FLAGS", cmProperty::VARIABLE,
  416. "Linker flags used to create executables.",
  417. "Flags used by the linker when creating an executable.",false,
  418. "Variables that Control the Build");
  419. cm->DefineProperty
  420. ("CMAKE_EXE_LINKER_FLAGS_[CMAKE_BUILD_TYPE]", cmProperty::VARIABLE,
  421. "Flag used when linking an executable.",
  422. "Same as CMAKE_C_FLAGS_* but used by the linker "
  423. "when creating executables.",false,
  424. "Variables that Control the Build");
  425. cm->DefineProperty
  426. ("CMAKE_LIBRARY_PATH_FLAG", cmProperty::VARIABLE,
  427. "The flag used to add a library search path to a compiler.",
  428. "The flag used to specify a library directory to the compiler. "
  429. "On most compilers this is \"-L\".",false,
  430. "Variables that Control the Build");
  431. cm->DefineProperty
  432. ("CMAKE_LINK_DEF_FILE_FLAG ", cmProperty::VARIABLE,
  433. "Linker flag used to specify a .def file for dll creation.",
  434. "The flag used to add a .def file when creating "
  435. "a dll on Windows, this is only defined on Windows.",false,
  436. "Variables that Control the Build");
  437. cm->DefineProperty
  438. ("CMAKE_LINK_LIBRARY_FLAG", cmProperty::VARIABLE,
  439. "Flag used to link a library into an executable.",
  440. "The flag used to specify a library to link to an executable. "
  441. "On most compilers this is \"-l\".",false,
  442. "Variables that Control the Build");
  443. cm->DefineProperty
  444. ("CMAKE_USE_RELATIVE_PATHS", cmProperty::VARIABLE,
  445. "Use relative paths (May not work!).",
  446. "If this is set to TRUE, then the CMake will use "
  447. "relative paths between the source and binary tree. "
  448. "This option does not work for more complicated "
  449. "projects, and relative paths are used when possible. "
  450. "In general, it is not possible to move CMake generated"
  451. " makefiles to a different location regardless "
  452. "of the value of this variable.",false,
  453. "Variables that Control the Build");
  454. cm->DefineProperty
  455. ("EXECUTABLE_OUTPUT_PATH", cmProperty::VARIABLE,
  456. "Location for all executables in a project.",
  457. "If set, this is the directory where all executables "
  458. "built during the build process will be placed.",false,
  459. "Variables that Control the Build");
  460. cm->DefineProperty
  461. ("LIBRARY_OUTPUT_PATH", cmProperty::VARIABLE,
  462. "Location for all libraries in a project.",
  463. "If set, this is the directory where all the libraries "
  464. "built during the build process will be placed.",false,
  465. "Variables that Control the Build");
  466. // Variables defined when the a language is enabled These variables will
  467. // also be defined whenever CMake has loaded its support for compiling (LANG)
  468. // programs. This support will be loaded whenever CMake is used to compile
  469. // (LANG) files. C and CXX are examples of the most common values for (LANG).
  470. cm->DefineProperty
  471. ("CMAKE_<LANG>_COMPILER", cmProperty::VARIABLE,
  472. "The full path to the compiler for LANG.",
  473. "This is the command that will be used as the <LANG> compiler. "
  474. "Once set, you can not change this variable.",false,
  475. "Variables for Languages");
  476. cm->DefineProperty
  477. ("CMAKE_COMPILER_IS_GNU<LANG>", cmProperty::VARIABLE,
  478. "True if the compiler is GNU.",
  479. "If the selected <LANG> compiler is the GNU "
  480. "compiler then this is TRUE, if not it is FALSE.",false,
  481. "Variables for Languages");
  482. cm->DefineProperty
  483. ("CMAKE_<LANG>_FLAGS_DEBUG", cmProperty::VARIABLE,
  484. "Flags for Debug build type or configuration.",
  485. "<LANG> flags used when CMAKE_BUILD_TYPE is Debug.",false,
  486. "Variables for Languages");
  487. cm->DefineProperty
  488. ("CMAKE_<LANG>_FLAGS_MINSIZEREL", cmProperty::VARIABLE,
  489. "Flags for MinSizeRel build type or configuration.",
  490. "<LANG> flags used when CMAKE_BUILD_TYPE is MinSizeRel."
  491. "Short for minimum size release.",false,
  492. "Variables for Languages");
  493. cm->DefineProperty
  494. ("CMAKE_<LANG>_FLAGS_RELEASE", cmProperty::VARIABLE,
  495. "Flags for Release build type or configuration.",
  496. "<LANG> flags used when CMAKE_BUILD_TYPE is Release",false,
  497. "Variables for Languages");
  498. cm->DefineProperty
  499. ("CMAKE_<LANG>_FLAGS_RELWITHDEBINFO", cmProperty::VARIABLE,
  500. "Flags for RelWithDebInfo type or configuration.",
  501. "<LANG> flags used when CMAKE_BUILD_TYPE is RelWithDebInfo. "
  502. "Short for Release With Debug Information.",false,
  503. "Variables for Languages");
  504. cm->DefineProperty
  505. ("CMAKE_<LANG>_COMPILE_OBJECT", cmProperty::VARIABLE,
  506. "Rule variable to compile a single object file.",
  507. "This is a rule variable that tells CMake how to "
  508. "compile a single object file for for the language <LANG>.",false,
  509. "Variables for Languages");
  510. cm->DefineProperty
  511. ("CMAKE_<LANG>_CREATE_SHARED_LIBRARY", cmProperty::VARIABLE,
  512. "Rule variable to create a shared library.",
  513. "This is a rule variable that tells CMake how to "
  514. "create a shared library for the language <LANG>.",false,
  515. "Variables for Languages");
  516. cm->DefineProperty
  517. ("CMAKE_<LANG>_CREATE_SHARED_MODULE", cmProperty::VARIABLE,
  518. "Rule variable to create a shared module.",
  519. "This is a rule variable that tells CMake how to "
  520. "create a shared library for the language <LANG>.",false,
  521. "Variables for Languages");
  522. cm->DefineProperty
  523. ("CMAKE_<LANG>_CREATE_STATIC_LIBRARY", cmProperty::VARIABLE,
  524. "Rule variable to create a static library.",
  525. "This is a rule variable that tells CMake how "
  526. "to create a static library for the language <LANG>.",false,
  527. "Variables for Languages");
  528. cm->DefineProperty
  529. ("CMAKE_<LANG>_IGNORE_EXTENSIONS", cmProperty::VARIABLE,
  530. "File extensions that should be ignored by the build.",
  531. "This is a list of file extensions that may be "
  532. "part of a project for a given language but are not compiled. ",false,
  533. "Variables for Languages");
  534. cm->DefineProperty
  535. ("CMAKE_<LANG>_LINKER_PREFERENCE", cmProperty::VARIABLE,
  536. "Determine if a language should be used for linking.",
  537. "If this is \"Preferred\" then if there is a mixed "
  538. "language shared library or executable, then this "
  539. "languages linker command will be used.",false,
  540. "Variables for Languages");
  541. cm->DefineProperty
  542. ("CMAKE_<LANG>_LINK_EXECUTABLE ", cmProperty::VARIABLE,
  543. "Rule variable to link and executable.",
  544. "Rule variable to link and executable for the given language.",false,
  545. "Variables for Languages");
  546. cm->DefineProperty
  547. ("CMAKE_<LANG>_OUTPUT_EXTENSION", cmProperty::VARIABLE,
  548. "Extension for the output of a compile for a single file.",
  549. "This is the extension for an object file for "
  550. "the given <LANG>. For example .obj for C on Windows.",false,
  551. "Variables for Languages");
  552. cm->DefineProperty
  553. ("CMAKE_<LANG>_SOURCE_FILE_EXTENSIONS", cmProperty::VARIABLE,
  554. "Extensions of source files for the given language.",
  555. "This is the list of extensions for a "
  556. "given languages source files.",false,"Variables for Languages");
  557. }