diff options
| author | Brad King <brad.king@kitware.com> | 2013-11-13 16:33:17 (GMT) |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2013-11-18 13:26:23 (GMT) |
| commit | 4ac75fdfe6e7a91f3beea037d13b1f4c8c8b80ed (patch) | |
| tree | e5ff1530703c83dd1c54ed8ef72158b37260ed16 /Help/variable | |
| parent | cc23f92861aeb2443cc5b6443c04a761c99bb100 (diff) | |
| download | CMake-4ac75fdfe6e7a91f3beea037d13b1f4c8c8b80ed.zip CMake-4ac75fdfe6e7a91f3beea037d13b1f4c8c8b80ed.tar.gz CMake-4ac75fdfe6e7a91f3beea037d13b1f4c8c8b80ed.tar.bz2 | |
Prefer CMAKE_MAKE_PROGRAM over CMAKE_BUILD_TOOL (#14548)
Historically these were both added for the Makefile and Visual Studio
generators, respectively. Later the VS generators started using the
CMAKE_MAKE_PROGRAM cache entry to find the IDE build tool, and the
CMAKE_BUILD_TOOL was simply set as an alias.
Fix the documentation to explain that CMAKE_MAKE_PROGRAM is the modern
variable and that CMAKE_BUILD_TOOL is the compatibility alias, not the
other way around. Replace uses of CMAKE_BUILD_TOOL with
CMAKE_MAKE_PROGRAM in CMake-provided modules. Nothing needs to lookup
CMAKE_BUILD_TOOL in the cache, so simply set it as a normal variable.
Diffstat (limited to 'Help/variable')
| -rw-r--r-- | Help/variable/CMAKE_BUILD_TOOL.rst | 11 | ||||
| -rw-r--r-- | Help/variable/CMAKE_MAKE_PROGRAM.rst | 9 |
2 files changed, 9 insertions, 11 deletions
diff --git a/Help/variable/CMAKE_BUILD_TOOL.rst b/Help/variable/CMAKE_BUILD_TOOL.rst index f0bc938..6133491 100644 --- a/Help/variable/CMAKE_BUILD_TOOL.rst +++ b/Help/variable/CMAKE_BUILD_TOOL.rst @@ -1,11 +1,6 @@ CMAKE_BUILD_TOOL ---------------- -Tool used for the actual 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_BUILD_TOOL 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. +This variable exists only for backwards compatibility. +It contains the same value as :variable:`CMAKE_MAKE_PROGRAM`. +Use that variable instead. diff --git a/Help/variable/CMAKE_MAKE_PROGRAM.rst b/Help/variable/CMAKE_MAKE_PROGRAM.rst index 8307bc6..b546815 100644 --- a/Help/variable/CMAKE_MAKE_PROGRAM.rst +++ b/Help/variable/CMAKE_MAKE_PROGRAM.rst @@ -1,7 +1,10 @@ CMAKE_MAKE_PROGRAM ------------------ -See CMAKE_BUILD_TOOL. +Tool used for the actual build process. -This variable is around for backwards compatibility, see -CMAKE_BUILD_TOOL. +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. |