diff options
Diffstat (limited to 'Source/cmDocumentVariables.cxx')
| -rw-r--r-- | Source/cmDocumentVariables.cxx | 520 |
1 files changed, 520 insertions, 0 deletions
diff --git a/Source/cmDocumentVariables.cxx b/Source/cmDocumentVariables.cxx new file mode 100644 index 0000000000..0819aa0ca2 --- /dev/null +++ b/Source/cmDocumentVariables.cxx @@ -0,0 +1,520 @@ +#include "cmDocumentVariables.h" +#include "cmake.h" + +void cmDocumentVariables::DefineVariables(cmake* cm) +{ + // Subsection: variables defined by cmake, that give + // information about the project, and cmake + cm->DefineProperty + ("CMAKE_COMMAND", cmProperty::VARIABLE, + "The full path to the cmake executable.", + "This is the full path to the CMake executable cmake which is " + "useful from custom commands that want to use the cmake -E " + "option for portable system commands. " + "(e.g. /usr/local/bin/cmake"); + cm->DefineProperty + ("CMAKE_BINARY_DIR", cmProperty::VARIABLE, + "The path to the top level of the build tree.", + "This is the full path to the top level of the current CMake " + "build tree. For an in-source build, this would be the same " + "as CMAKE_SOURCE_DIR. "); + cm->DefineProperty + ("CMAKE_SOURCE_DIR", cmProperty::VARIABLE, + "The path to the top level of the source tree.", + "This is the full path to the top level of the current CMake " + "source tree. For an in-source build, this would be the same " + "as CMAKE_BINARY_DIR. "); + cm->DefineProperty + ("CMAKE_CURRENT_BINARY_DIR", cmProperty::VARIABLE, + "The path to the binary directory currently being processed.", + "This the full path to the build directory that is currently " + "being processed by cmake. Each directory added by " + "add_subdirectory will create a binary directory in the build " + "tree, and as it is being processed this variable will be set. " + "For in-source builds this is the current source directory " + "being processed."); + cm->DefineProperty + ("CMAKE_CURRENT_SOURCE_DIR", cmProperty::VARIABLE, + "The path to the source directory currently being processed.", + "This the full path to the source directory that is currently " + "being processed by cmake. "); + cm->DefineProperty + ("CMAKE_CURRENT_LIST_FILE", cmProperty::VARIABLE, + "The path to the file currently being processed.", + "This the full path to the file that is currently " + "being processed by cmake. "); + cm->DefineProperty + ("CMAKE_CURRENT_LIST_LINE", cmProperty::VARIABLE, + "The line number of the current file being processed.", + "This is the line number of the file currently being" + " processed by cmake."); + cm->DefineProperty + ("CMAKE_BUILD_TOOL", cmProperty::VARIABLE, + "Tool used for the acutal build process.", + "This variable is set to the program that will be" + " needed to build the output of CMake. If the " + "generator selected was Visual Studio 6, the " + "CMAKE_MAKE_PROGRAM will be set to msdev, for " + "Unix makefiles it will be set to make or gmake, " + "and for Visual Studio 7 it set to devenv. For " + "Nmake Makefiles the value is nmake. This can be " + "useful for adding special flags and commands based" + " on the final build environment. "); + cm->DefineProperty + ("CMAKE_CACHEFILE_DIR", cmProperty::VARIABLE, + "The directory with the CMakeCache.txt file.", + "This is the full path to the directory that has the " + "CMakeCache.txt file in it. This is the same as " + "CMAKE_BINARY_DIR."); + cm->DefineProperty + ("CMAKE_CACHE_MAJOR_VERSION", cmProperty::VARIABLE, + "Major version of CMake used to create the CMakeCache.txt file", + "This is stores the major version of CMake used to " + "write a CMake cache file. It is only different when " + "a different version of CMake is run on a previously " + "created cache file."); + cm->DefineProperty + ("CMAKE_CACHE_MINOR_VERSION", cmProperty::VARIABLE, + "Minor version of CMake used to create the CMakeCache.txt file", + "This is stores the minor version of CMake used to " + "write a CMake cache file. It is only different when " + "a different version of CMake is run on a previously " + "created cache file."); + + cm->DefineProperty + ("CMAKE_CACHE_RELEASE_VERSION", cmProperty::VARIABLE, + "Release version of CMake used to create the CMakeCache.txt file", + "This is stores the release version of CMake used to " + "write a CMake cache file. It is only different when " + "a different version of CMake is run on a previously " + "created cache file."); + + cm->DefineProperty + ("CMAKE_CFG_INTDIR", cmProperty::VARIABLE, + "Build time configuration directory for project.", + "This is a variable that is used to provide developers" + " access to the intermediate directory used by Visual " + "Studio IDE projects. For example, if building " + "Debug all executables and libraries end up in a " + "Debug directory. On UNIX systems this variable " + "is set to \".\". However, with Visual Studio this " + "variable is set to $(IntDir). $(IntDir) is expanded " + "by the IDE only. So this variable should only be " + "used in custom commands that will be run during " + "the build process. This variable should not be " + "used directly in a CMake command. CMake has no " + "way of knowing if Debug or Release will be picked " + "by the IDE for a build type. If a program needs to " + "know the directory it was built in, it can use " + "CMAKE_INTDIR. CMAKE_INTDIR is a C/C++ preprocessor " + "macro that is defined on the command line of the " + "compiler. If it has a value, it will be the " + "intermediate directory used to build the file. " + "This way an executable or a library can find files " + "that are located in the build directory."); + + cm->DefineProperty + ("CMAKE_CTEST_COMMAND", cmProperty::VARIABLE, + "Full path to ctest command installed with cmake.", + "This is the full path to the CTest executable ctest " + "which is useful from custom commands that want " + " to use the cmake -E option for portable system " + "commands."); + cm->DefineProperty + ("CMAKE_DL_LIBS", cmProperty::VARIABLE, + "Name of library containing dlopen and dlcose.", + "The name of the library that has dlopen and " + "dlclose in it, usually -ldl on most UNIX machines."); + cm->DefineProperty + ("CMAKE_EDIT_COMMAND", cmProperty::VARIABLE, + "Full path to CMakeSetup or ccmake.", + "This is the full path to the CMake executable " + "that can graphically edit the cache. For example," + " CMakeSetup, ccmake, or cmake -i."); + cm->DefineProperty + ("CMAKE_GENERATOR", cmProperty::VARIABLE, + "The generator used to build the project.", + "The name of the generator that is being used to generate the " + "build files. (e.g. \"Unix Makefiles\", " + "\"Visual Studio 6\", etc.)"); + cm->DefineProperty + ("CMAKE_HOME_DIRECTORY", cmProperty::VARIABLE, + "Path to top of source tree.", + "This is the path to the top level of the source tree."); + cm->DefineProperty + ("CMAKE_LINK_LIBRARY_SUFFIX", cmProperty::VARIABLE, + "The suffix for libraries that you link to.", + "The suffix to use for the end of a library, .lib on Windows."); + cm->DefineProperty + ("CMAKE_MAJOR_VERSION", cmProperty::VARIABLE, + "The Major version of cmake (i.e. the 2 in 2.X.X)", + "This specifies the major version of the CMake executable" + " being run."); + cm->DefineProperty + ("CMAKE_MAKE_PROGRAM", cmProperty::VARIABLE, + "See CMAKE_BUILD_TOOL.", + "This variable is around for backwards compatibility, " + "see CMAKE_BUILD_TOOL."); + cm->DefineProperty + ("CMAKE_MINOR_VERSION", cmProperty::VARIABLE, + "The Minor version of cmake (i.e. the 4 in X.4.X).", + "This specifies the minor version of the CMake" + " executable being run."); + cm->DefineProperty + ("CMAKE_PROJECT_NAME", cmProperty::VARIABLE, + "The name of the current project.", + "This specifies name of the current project from" + " the closest inherited PROJECT command."); + cm->DefineProperty + ("CMAKE_RANLIB", cmProperty::VARIABLE, + "Name of randomizing tool for static libraries.", + "This specifies name of the program that randomizes " + "libraries on UNIX, not used on Windows, but may be present."); + cm->DefineProperty + ("CMAKE_ROOT", cmProperty::VARIABLE, + "Install directory for running cmake.", + "This is the install root for the running CMake and" + " the Modules directory can be found here. This is" + " commonly used in this format: ${CMAKE_ROOT}/Modules"); + cm->DefineProperty + ("CMAKE_SIZEOF_VOID_P", cmProperty::VARIABLE, + "Size of a void pointer.", + "This is set to the size of a pointer on the machine, " + "and is determined by a try compile. If a 64 bit size " + "is found, then the library search path is modified to " + "look for 64 bit libraries first."); + cm->DefineProperty + ("CMAKE_SKIP_RPATH", cmProperty::VARIABLE, + "If true, do not add run time path information.", + "If this is set to TRUE, then the rpath information " + "is not added to compiled executables. The default" + "is to add rpath information if the platform supports it." + "This allows for easy running from the build tree."); + cm->DefineProperty + ("CMAKE_SOURCE_DIR", cmProperty::VARIABLE, + "Source directory for project.", + "This is the top level source directory for the project. " + "It corresponds to the source directory given to " + "CMakeSetup or ccmake."); + cm->DefineProperty + ("CMAKE_STANDARD_LIBRARIES", cmProperty::VARIABLE, + "Libraries linked into every executable and shared library.", + "This is the list of libraries that are linked " + "into all executables and libraries."); + cm->DefineProperty + ("CMAKE_USING_VC_FREE_TOOLS", cmProperty::VARIABLE, + "True if free visual studio tools being used.", + "This is set to true if the compiler is Visual " + "Studio free tools."); + cm->DefineProperty + ("CMAKE_VERBOSE_MAKEFILE", cmProperty::VARIABLE, + "Create verbose makefiles if on.", + "This variable defaults to false. You can set " + "this variable to true to make CMake produce verbose " + "makefiles that show each command line as it is used."); + cm->DefineProperty + ("PROJECT_BINARY_DIR", cmProperty::VARIABLE, + "Full path to build directory for project.", + "This is the binary directory of the most recent " + "PROJECT command."); + cm->DefineProperty + ("PROJECT_NAME", cmProperty::VARIABLE, + "Name of the project given to the project command.", + "This is the name given to the most " + "recent PROJECT command. "); + cm->DefineProperty + ("PROJECT_SOURCE_DIR", cmProperty::VARIABLE, + "Top level source directory for the current project.", + "This is the source directory of the most recent " + "PROJECT command."); + cm->DefineProperty + ("[Project name]_BINARY_DIR", cmProperty::VARIABLE, + "Top level binary directory for the named project.", + "A variable is created with the name used in the PROJECT " + "command, and is the binary directory for the project. " + " This can be useful when SUBDIR is used to connect " + "several projects."); + cm->DefineProperty + ("[Project name]_SOURCE_DIR", cmProperty::VARIABLE, + "Top level source directory for the named project.", + "A variable is created with the name used in the PROJECT " + "command, and is the source directory for the project." + " This can be useful when add_subdirectory " + "is used to connect several projects."); + + // Variables defined by cmake, that change the behavior + // of cmake + cm->DefineProperty + ("CMAKE_BUILD_TYPE", cmProperty::VARIABLE, + "Specifies the build type for make based generators.", + "This specifies what build type will be built in this tree. " + " Possible values are empty, Debug, Release, RelWithDebInfo" + " and MinSizeRel. This variable is only supported for " + "make based generators. If this variable is supported, " + "then CMake will also provide initial values for the " + "variables with the name " + " CMAKE_C_FLAGS_[Debug|Release|RelWithDebInfo|MinSizeRel]." + " For example, if CMAKE_BUILD_TYPE is Debug, then " + "CMAKE_C_FLAGS_DEBUG will be added to the CMAKE_C_FLAGS."); + + cm->DefineProperty + ("CMAKE_BACKWARDS_COMPATIBILITY", cmProperty::VARIABLE, + "Version of cmake required to build project", + "From the point of view of backwards compatibility, this " + "specifies what version of CMake should be supported. By " + "default this value is the version number of CMake that " + "you are running. You can set this to an older version of" + " CMake to support deprecated commands of CMake in projects" + " that were written to use older versions of CMake. This " + "can be set by the user or set at the beginning of a " + "CMakeLists file."); + + cm->DefineProperty + ("CMAKE_INSTALL_PREFIX", cmProperty::VARIABLE, + "Install directory used by install.", + "If \"make install\" is invoked or INSTALL is built" + ", this directory is pre-pended onto all install " + "directories. This variable defaults to /usr/local" + " on UNIX and c:/Program Files on Windows."); + cm->DefineProperty + ("CMAKE_USER_MAKE_RULES_OVERRIDE", cmProperty::VARIABLE, + "Specify a file that can change the build rule variables.", + "If this variable is set, it should to point to a " + "CMakeLists.txt file that will be read in by CMake " + "after all the system settings have been set, but " + "before they have been used. This would allow you " + "to override any variables that need to be changed " + "for some special project. "); + + cm->DefineProperty + ("BUILD_SHARED_LIBS", cmProperty::VARIABLE, + "Global flag to cause add_library to create shared libraries if on.", + "If present and true, this will cause all libraries to be " + "built shared unless the library was explicitly added as a " + "static library. This variable is often added to projects " + "as an OPTION so that each user of a project can decide if " + "they want to build the project using shared or static " + "libraries."); + + cm->DefineProperty + ("CMAKE_NOT_USING_CONFIG_FLAGS", cmProperty::VARIABLE, + "Skip _BUILD_TYPE flags if true.", + "This is an internal flag used by the generators in " + "CMake to tell CMake to skip the _BUILD_TYPE flags."); + + cm->DefineProperty + ("CMAKE_MFC_FLAG", cmProperty::VARIABLE, + "Tell cmake to use MFC for an executable or dll.", + "This can be set in a CMakeLists.txt file and will " + "enable MFC in the application. It should be set " + "to 1 for static the static MFC library, and 2 for " + "the shared MFC library. This is used in visual " + "studio 6 and 7 project files. The CMakeSetup " + "dialog uses MFC and the CMakeLists.txt looks like this:\n" + "ADD_DEFINITIONS(-D_AFXDLL)\n" + "set(CMAKE_MFC_FLAG 2)\n" + "add_executable(CMakeSetup WIN32 ${SRCS})\n"); + + + // Variables defined by CMake that describe the system + + cm->DefineProperty + ("CMAKE_SYSTEM", cmProperty::VARIABLE, + "Name of system cmake is being run on.", + "This variable is the composite of CMAKE_SYSTEM_NAME" + "and CMAKE_SYSTEM_VERSION, like this " + "${CMAKE_SYSTEM_NAME}-${CMAKE_SYSTEM_VERSION}. " + "If CMAKE_SYSTEM_VERSION is not set, then " + "CMAKE_SYSTEM is the same as CMAKE_SYSTEM_NAME."); + cm->DefineProperty + ("CMAKE_SYSTEM_NAME", cmProperty::VARIABLE, + "Name of the OS CMake is running on.", + "This is the name of the operating system on " + "which CMake is running. On systems that " + "have the uname command, this variable is set " + "to the output of uname -s. Linux, Windows, " + " and Darwin for Mac OSX are the values found " + " on the big three operating systems." ); + cm->DefineProperty + ("CMAKE_SYSTEM_PROCESSOR", cmProperty::VARIABLE, + "The name of the CPU CMake is running on.", + "On systems that support uname, this variable is " + "set to the output of uname -p, on windows it is " + "set to the value of the environment variable " + "PROCESSOR_ARCHITECTURE"); + cm->DefineProperty + ("CMAKE_SYSTEM_VERSION", cmProperty::VARIABLE, + "OS version.", + "A numeric version string for the system, on " + "systems that support uname, this variable is " + "set to the output of uname -r. On other " + "systems this is set to major-minor version numbers."); + + cm->DefineProperty + ("APPLE", cmProperty::VARIABLE, + "True if running on Mac OSX.", + "Set to true on Mac OSX."); + + cm->DefineProperty + ("BORLAND", cmProperty::VARIABLE, + "True of the borland compiler is being used.", + "This is set to true if the Borland compiler is being used."); + + cm->DefineProperty + ("CYGWIN", cmProperty::VARIABLE, + "True for cygwin.", + "Set to true when using CYGWIN."); + + cm->DefineProperty + ("UNIX", cmProperty::VARIABLE, + "True for UNIX and UNIX like operating systems.", + "Set to true when the system is UNIX or UNIX like " + "(i.e. APPLE and CYGWIN)."); + + cm->DefineProperty + ("WIN32", cmProperty::VARIABLE, + "Tru on windows systems, including win64.", + "Set to true when the system is Windows and on cygwin."); + + // Variables that affect the building of object files and + // targets. + // + cm->DefineProperty + ("CMAKE_EXE_LINKER_FLAGS", cmProperty::VARIABLE, + "Linker flags used to create executables.", + "Flags used by the linker when creating an executable."); + + cm->DefineProperty + ("CMAKE_EXE_LINKER_FLAGS_[CMAKE_BUILD_TYPE]", cmProperty::VARIABLE, + "Flag used when linking an executable.", + "Same as CMAKE_C_FLAGS_* but used by the linker " + "when creating executables."); + cm->DefineProperty + ("CMAKE_LIBRARY_PATH_FLAG", cmProperty::VARIABLE, + "The flag used to add a library search path to a compiler.", + "The flag used to specify a library directory to the compiler. " + "On most compilers this is \"-L\"."); + cm->DefineProperty + ("CMAKE_LINK_DEF_FILE_FLAG ", cmProperty::VARIABLE, + "Linker flag used to specify a .def file for dll creation.", + "The flag used to add a .def file when creating " + "a dll on Windows, this is only defined on Windows."); + cm->DefineProperty + ("CMAKE_LINK_LIBRARY_FLAG", cmProperty::VARIABLE, + "Flag used to link a library into an executable.", + "The flag used to specify a library to link to an executable. " + "On most compilers this is \"-l\"."); + cm->DefineProperty + ("CMAKE_USE_RELATIVE_PATHS", cmProperty::VARIABLE, + "Use relative paths (May not work!).", + "If this is set to TRUE, then the CMake will use " + "relative paths between the source and binary tree. " + "This option does not work for more complicated " + "projects, and relative paths are used when possible. " + "In general, it is not possible to move CMake generated" + " makefiles to a different location regardless " + "of the value of this variable."); + cm->DefineProperty + ("EXECUTABLE_OUTPUT_PATH", cmProperty::VARIABLE, + "Location for all executables in a project.", + "If set, this is the directory where all executables " + "built during the build process will be placed."); + cm->DefineProperty + ("LIBRARY_OUTPUT_PATH", cmProperty::VARIABLE, + "Location for all libraries in a project.", + "If set, this is the directory where all the libraries " + "built during the build process will be placed."); + +// Variables defined when the a language is enabled These variables will +// also be defined whenever CMake has loaded its support for compiling (LANG) +// programs. This support will be loaded whenever CMake is used to compile +// (LANG) files. C and CXX are examples of the most common values for (LANG). + + cm->DefineProperty + ("CMAKE_<LANG>_COMPILER", cmProperty::VARIABLE, + "The full path to the compiler for LANG.", + "This is the command that will be used as the <LANG> compiler. " + "Once set, you can not change this variable."); + + cm->DefineProperty + ("CMAKE_COMPILER_IS_GNU<LANG>", cmProperty::VARIABLE, + "True if the compiler is GNU.", + "If the selected <LANG> compiler is the GNU " + "compiler then this is TRUE, if not it is FALSE. "); + + cm->DefineProperty + ("CMAKE_<LANG>_FLAGS_DEBUG", cmProperty::VARIABLE, + "Flags for Debug build type or configuration.", + "<LANG> flags used when CMAKE_BUILD_TYPE is Debug."); + + cm->DefineProperty + ("CMAKE_<LANG>_FLAGS_MINSIZEREL", cmProperty::VARIABLE, + "Flags for MinSizeRel build type or configuration.", + "<LANG> flags used when CMAKE_BUILD_TYPE is MinSizeRel." + "Short for minimum size release."); + + cm->DefineProperty + ("CMAKE_<LANG>_FLAGS_RELEASE", cmProperty::VARIABLE, + "Flags for Release build type or configuration.", + "<LANG> flags used when CMAKE_BUILD_TYPE is Release"); + + cm->DefineProperty + ("CMAKE_<LANG>_FLAGS_RELWITHDEBINFO", cmProperty::VARIABLE, + "Flags for RelWithDebInfo type or configuration.", + "<LANG> flags used when CMAKE_BUILD_TYPE is RelWithDebInfo. " + "Short for Release With Debug Information."); + + cm->DefineProperty + ("CMAKE_<LANG>_COMPILE_OBJECT", cmProperty::VARIABLE, + "Rule variable to compile a single object file.", + "This is a rule variable that tells CMake how to " + "compile a single object file for for the language <LANG>."); + + cm->DefineProperty + ("CMAKE_<LANG>_CREATE_SHARED_LIBRARY", cmProperty::VARIABLE, + "Rule variable to create a shared library.", + "This is a rule variable that tells CMake how to " + "create a shared library for the language <LANG>."); + + cm->DefineProperty + ("CMAKE_<LANG>_CREATE_SHARED_MODULE", cmProperty::VARIABLE, + "Rule variable to create a shared module.", + "This is a rule variable that tells CMake how to " + "create a shared library for the language <LANG>."); + + cm->DefineProperty + ("CMAKE_<LANG>_CREATE_STATIC_LIBRARY", cmProperty::VARIABLE, + "Rule variable to create a static library.", + "This is a rule variable that tells CMake how " + "to create a static library for the language <LANG>."); + + cm->DefineProperty + ("CMAKE_<LANG>_IGNORE_EXTENSIONS", cmProperty::VARIABLE, + "File extensions that should be ignored by the build.", + "This is a list of file extensions that may be " + "part of a project for a given language but are not compiled. "); + + cm->DefineProperty + ("CMAKE_<LANG>_LINKER_PREFERENCE", cmProperty::VARIABLE, + "Determine if a language should be used for linking.", + "If this is \"Preferred\" then if there is a mixed " + "language shared library or executable, then this " + "languages linker command will be used."); + + cm->DefineProperty + ("CMAKE_<LANG>_LINK_EXECUTABLE ", cmProperty::VARIABLE, + "Rule variable to link and executable.", + "Rule variable to link and executable for the given language."); + + cm->DefineProperty + ("CMAKE_<LANG>_OUTPUT_EXTENSION", cmProperty::VARIABLE, + "Extension for the output of a compile for a single file.", + "This is the extension for an object file for " + "the given <LANG>. For example .obj for C on Windows."); + + cm->DefineProperty + ("CMAKE_<LANG>_SOURCE_FILE_EXTENSIONS", cmProperty::VARIABLE, + "Extensions of source files for the given language.", + "This is the list of extensions for a " + "given languages source files."); +} |