What's new in CMake
This is an abbreviated version of the CMake changelog with just the highlights for authors. Names for each release are arbitrarily picked by the author.
CMake in development: WIP
- Linker selection option (
CMAKE_LINKER_TYPE
/LINKER_TYPE
) CMAKE_INSTALL_PREFIX
can now be initialized by a matching environment variable- If commands to check file permissions
- Select launcher for tests (
CMAKE_TEST_LAUNCHER
/TEST_LAUNCHER
) - You can now make tests depend on
all
withCMAKE_SKIP_TEST_ALL_DEPENDENCY
set toFALSE
! - Select Intel OneAPI Fortran compiler with Visual Studio
CMake 3.28: C++20 modules
This release adds C++ module
support. This does not include C++23's import std
, but is exciting step
forward for this landmark C++20 feature. These will be scanned by default if
using C++20+ and a new enough compiler and valid generator and if you have a
CMake minimum or maximum that includes CMake 3.28.
- Initially released December 6, 2023
- C++20 named modules supported by Ninja 1.11+ and MSVC 17.4+.
HIP
supported for NVIDIA.- Apple's VisionOS added.
CMAKE_CROSSCOMPILING_EMULATOR
environment variable added.- Get/set properties TEST supports other DIRECTORY's
- Some support for job servers added
- Support for passing variables to pkg-config
- Generator expressions now support short-circuting
CMake 3.27: Debugger
This release adds the new CMake debugger! This should improve support for debugging your CMake code in something like VSCode. This release also "removes" FindPythonLibs/FindPythonInterp/FindCUDA; if the min or max version is set to 3.27 or higher, the modules will be missing.
- Initially released July 19, 2023
- C++ Modules extensions (
.ccm
,.cxxm
,.c++m
) are treated as C++ COMPILE_ONLY
,LIST
, andPATH
generator expressions added, along with a few more specific ones.- New
SKIP_LINTING
, as well as more generator expression support in things like<LANG>_CPPCHECK
, etc. find_package
now searches for uppercase<PACKAGENAME>_ROOT
CMake/Environment variables.- Added
add_custom_command(... DEPENDS_EXPLICIT_ONLY
& variable for Ninja dependency control. - CMake build verbose now prints the working dir and command line used to build.
- Better support for versions of MSVC.
- Several new CUDA properties related to targeting .
cubin
/.fatbin
/.optixir
. - Setting
cmake_minimum_required
less than 3.5 is now deprecated. - FindCUDA simi-removed, use CUDA language and FindCUDAToolkit.
- FindPythonLibs & FindPythonInterp simi-removed, use FindPython.
CMake 3.26: Logging & Python
Two important additions for FindPython, PyPy SOABI support & LimitedAPI/StableABI support, really enhance FindPython's use. There are quite
a few nice fixes and new warnings, such as if you reverse the order of project()
and cmake_minimium_required()
. Logging has been moved
from CMakeOutput.log
and CMakeError.log
to a new CMakeConfigureLog.yaml
log.
- Initially released March 14, 2023
- FindPython generates the correct PyPy SOABI (finally!)
- FindPython supports LimitedAPI/StableABI with a new flag.
- CMake has a new YAML log of configure time checks in the output directory (also
message(CONFIGURE_LOG ...)
). ASM_MARMASM
language added for Microsoft ARM assembler.CMAKE_VS_VERSION_BUILD_NUMBER
added for the VS version number.USE_FOLDERS
is on by default"<LANG>_CLANG_TIDY_EXPORT_FIXES_DIR"
for clang-tidy suggested fix output.- CMake's copy CLI tool supports updates only if different
target_compile_options
now come aftertarget_compile_features
/CMAKE_<LANG>_STANDARD
CMake 3.25: Blocks and SYSTEM
CMake has new block scoping commands selectively controlling variables and
policies. It also has a lot more control over SYSTEM. The functional features
of CMake introduced a few releases ago are now usable in find_
commands with
VALIDATOR
. Workflows got an upgrade, too.
- Initially released November 16, 2022
- C++26 support
- LTO for CUDA with nvcc
- Workflow presets added, package presets too.
SYSTEM
added toadd_subdirectory
,FetchContent
, and as a directory propertyblock()
/endblock()
for policy/variable scopes, alsoPROPOGATE
inreturn()
BSD
&LINUX
variables addedVALIDATOR
function forfind_*
commands.- Several improvements to
try_*
commands. SYSTEM
target/directory property andEXPORT_NO_SYSTEM
added, also for FetchContent.
CMake 3.24: Package Finder
This is a fantastic release. Package writers are getting integration between
find_package
and FetchContent
that will allow "download if missing"
workflows, and is configurable by packagers. Similarly, warnings as errors can
be set by a package and removed by packagers, as well (still make sure not to
do this unless you are being build as the main project!).
- Initially released August 4, 2022
--fresh
option removes the old cache when running.find_package
andFetchContent
now have integration - you have options to download missing dependencies.find_package
has a newGLOBAL
option.CMAKE_PROJECT_TOP_LEVEL_INCLUDES
allows a user (like packagers) to inject pre-project code.PATH
management for generator expressions.CMAKE_COLOR_DIAGNOSTICS
env var & variable added, replacingCMAKE_COLOR_MAKEFILE
.- You can disable
find_*
searching the install prefix. COMPILE_WARNING_AS_ERROR
property andCMAKE_
variable, and--compile-no-warning-as-error
to disable it.- CUDA supports
native
to compile for the current GPUs detected. SYSTEM
includes now are respected on MSVC generators.- Better support for MSVC, XCode, and others.
LLVMFlang
compiler support.
CMake 3.23: Header only libraries
A solid release focused on header only libraries, more user control, CMake
presets, and better CUDA support. There are some powerful new features for
header only libraries, like the various *_SETS
target properties. There are
new controls like the ability to restrict paths for find_
commands and the
ability to remove SYSTEM
from an existing target. You also get expanded
debugging features, and the ability to force all links to be to targets.
Presets can include other files. CUDA and C# received new updates, and a
couple of compilers were added.
- Initially released March 29, 2022
- CMake presets are a bit nicer, with the ability to include other files.
- A couple of new supported compilers, and better C# support.
FILE_SET
forinstall
andtarget_sources
header-only source files.<INTERFACE_>HEADER_SETS
,<INTERFACE_>HEADER_DIRS
for target headers.CUDA_ARCHITECTURES
support for all and all-major.a- DEBUG messages from can be enabled for
find_*
or find modules. define_property()
has a handyINITIALIZE_FROM_VARIABLE
option.CMAKE_<SYSTEM_>IGNORE_PREFIX_PATH
to controlfind_*
commands.<CMAKE_>LINK_LIBRARIES_ONLY_TARGETS
added to force only targets linked (nice for finding mistakes!).IMPORTED_NO_SYSTEM
, a new property to forcibly remove SYSTEM from a target.FindGTest
now adds aGMock
target if found.
CMake 3.22: Handy env vars
A smaller release with some nice improvements all around focused on supporting
common build situations. You can finally set CMAKE_BUILD_TYPE
in your
environment to set a default build type. There are several other new env vars
and variables too. Compiler flags related to standards have been improved.
cmake_host_system_information
got improved further (from 3.10) with OS
information.
- Initially released November 18, 2021
- New environment variables for defaults,
CMAKE_BUILD_TYPE
andCMAKE_CONFIGURATION_TYPES
- New environment variable
CMAKE_INSTALL_MODE
for install types (symlinks) - New
CMAKE_REQUIRE_FIND_PACKAGE_<PackageName>
variable to convert an optional find to a required one CMAKE_<LANG>_EXTENSIONS_DEFAULT
comes from the compilerCMakeDependentOption
uses normal conditional syntax now- CTest can now modify environment variables
- Some generators now use external (system) markers on includes for MSVC
CMake 3.21 : Colors
Different message types now have different colors! There's now a nice variable to see if you are in the top level project. Lots of continued cleanup and specialized new features, such as adding the HIP language and C17 and C23 support. Presets continue to be improved.
- Initially released July 14, 2021
- Preliminary support for MSVC 2022
CMAKE_<LANG>_LINKER_LAUNCHER
added for make and ninja- HIP added as a language
- C17 and C23 support added
--install-prefix <dir>
and--toolchain <file>
added when running CMake- Messages printed are colored by message type!
- Support for MSYS, including
FindMsys
- The
file(
command got several updates, includingEXPAND_TILDE
- Support for runtime dependencies and artifacts added to
install
PROJECT_IS_TOP_LEVEL
and<PROJECT-NAME>_IS_TOP_LEVEL
finally added- Caching improvements for the
find_
commands
CMake 3.20 : Docs
The CMake docs received a major boost in productivity by adding "new in" tags
to quickly see what was added without having to toggle documentation versions!
C++ 23 support added. Source files must have the extension listed now, and
LANGUAGE is always respected. Quite a bit of cleanup was done; make sure your
code is tested with ...3.20
before deploying that as your maximum. Presets
continue to be improved.
- Initially released March 23, 2021
- Support added for C++23
- CUDAARCHS environment variable for setting CUDA architectures
- The new
IntelLLVM
compilers are now supported (OneAPI 2021.1), andNVHPC
NVIDIA HPC SDK, as well - Some expanded generator expression support in custom commands/targets, install renaming
- New
cmake_path
command for working with paths try_run
now has aWORKING_DIRECTORY
- More features for the
file(GENERATE
command - Several removals, like
cmake-server
,WriteCompilerDetectionHeader
(if policy set to 3.20+), and a few things that have newer methods now. - Source files must include the extension
CMake 3.19 : Presets
You can now add presets in JSON form, and users will get the preset default.
find_package
can now take a version range, and some specialty find modules,
like FindPython, have custom support for it. A lot of new controls were added
for permissions. Further support for generator expressions in more places.
- Initially released November 18, 2020
- New CMake presets files now supported - you can set defaults for your project per generator, or you can make User presets. PSA: Please add
CMakeUserPresets.json
to your.gitignore
, even if you do not useCMakePresets.json
. - CMake now uses the new build system introduced in XCode 12+
- MSVC for Android now supported
cmake -E create_hardlink
was addedadd_test
finally properly supports whitespace in test names- You can now
DEFER
cmake_language
to run at the end of the directory processing - Lots of new
file
options, like temporary downloads andCOMPRESSION_LEVEL
forARCHIVE_CREATE
find_package
supports a version rangeDIRECTORY
can now include a binary directory in property commands- New
JSON
commands forstring
- New
OPTIMIZE_DEPENDENCIES
property andCMAKE_*
variable for smartly dropping dependencies of static and object libraries. - PCH support expanded with
PCH_INSTANTIATE_TEMPLATES
property andCMAKE_*
variable. - Check modules have been expanded with
CUDA
andISPC
languages - FindPython:
Python*_LINK_OPTIONS
added compute-sanitizer
for ctest now supports CUDA for memcheck
CMake 3.18 : CUDA with Clang & CMake macro language
CUDA now supports Clang (without separable compilation). A new
CUDA_ARCHITECTURES
property was implemented to better support targeting CUDA
hardware. A new cmake_language
command supports calling cmake commands and
expressions from strings. Lots of other meta changes that could make new
designs available; calling functions by variable, evaluating arbitrary CMake by
string, and configure files directly from strings. Many other nice tiny
features and papercut fixes are sprinkled throughout, a small selection is below.
- Initially released July 15, 2020
cmake
cancat
files together now- New profiling mode for
cmake
cmake_language
withCALL
andEVAL
export
requiresAPPEND
if used multiple times (in CMake language level 3.18+)- You can archive directly from
file()
file(CONFIGURE
is a nicer form ofconfigure_file
if you already have a string to produce- Other
find_*
commands gainfind_package
'sREQUIRED
flag NATURAL
sorting inlist(SORT
added- More options for handling properties with DIRECTORY scope
CUDA_ARCHITECTURES
was added- New
LINK_LANGUAGE
generator expressions (DEVICE
/HOST
versions too) - Source can be a subdirectory for
FetchContent
CMake 3.17 : More CUDA
A FindCUDAToolkit was finally added, which allows finding and using the CUDA toolkit without enabling the CUDA language! CUDA now is a bit more configurable, such as linking to shared libraries. Quite a bit more polish in the expected areas, as well, like FindPython. Finally, you can now iterate over multiple lists at a time.
- Initially released March 20, 2020
CUDA_RUNTIME_LIBRARY
can finally be set to Shared!- FindCUDAToolkit finally added
cmake -E rm
replaces older remove commands- CUDA has meta features like
cuda_std_03
, etc. - You can track the searches for packages with
--debug-find
- ExternalProject can now disable recursive checkouts
- FindPython better integration with Conda
- DEPRECATION can be applied to targets
- CMake gained a rm command
- Several new environment variables
- foreach can now do
ZIP_LISTS
(multiple lists at a time)
CMake 3.16 : Unity builds
A new unity build mode was added, allowing source files to be merged into a single build file. Support for precompiled headers (possibly preparing for C++20 modules, perhaps?) was added. Lots of other smaller fixes were implemented, especially to newer features, such as to FindPython, FindDoxygen, and others.
- Initially released November 26, 2019
- Added support for Objective C and Objective C++ languages
- Support for precompiling headers, with
target_precompile_headers
- Support for "Unity" or "Jumbo" builds (merging source files) with
CMAKE_UNITY_BUILD
- CTest: Can now skip based on regex, expand lists
- Several new features to control RPath.
- Generator expressions work in more places, like build and install paths
- Find locations can now be explicitly controlled through new variables
CMake 3.15 : CLI upgrade
This release has many smaller polishing changes, include several of improvements to the CMake command line, such as control over the default generator through environment variables (so now it's easy to change the default generator to Ninja). Multiple targets are supported in --build
mode, and --install
mode added. CMake finally supports multiple levels of logging. Generator expressions gained a few handy tools. The still very new FindPython module continues to improve, and FindBoost is now more inline with Boost 1.70's new CONFIG
module. export(PACKAGE)
has drastically changed; it now no longer touches $HOME/.cmake
by default (if CMake Minimum version is 3.15 or higher), and requires an extra step if a user wants to use it. This is generally less surprising.
- Initially released July 17, 2019
CMAKE_GENERATOR
environment variable added to control default generator- Multiple target support in build mode,
cmake . --build --target a b
- Shortcut
-t
for--target
- Install support,
cmake . --install
, does not invoke the build system - Support for
--loglevel
andNOTICE
,VERBOSE
,DEBUG
, andTRACE
formessage
- The
list
command gainedPREPEND
,POP_FRONT
, andPOP_BACK
execute_process
gainedCOMMAND_ECHO
option (CMAKE_EXECUTE_PROCESS_COMMAND_ECHO
) allows you to automatically echo commands before running them- Several Ninja improvements, include SWIFT language support
- Compiler and list improvements to generator expressions
CMake 3.14 : File utilities (AKA CMake π)
This release has lots of small cleanups, including several utilities for files. Generator expressions work in a few more places, and list handling is better with empty variables. Quite a few more find packages produce targets. The new Visual Studio 16 2019 generator is a bit different than older versions. Windows XP and Vista support has been dropped.
- Initially released March 14, 2019
- The cmake
--build
command gained-v/--verbose
, to use verbose builds if your build tool supports it - The FILE command gained
CREATE_LINK
,READ_SYMLINK
, andSIZE
get*filename_component
gainedLAST_EXT
andNAME_WLE
to access just the _last* extension on a file, which would get.zip
on a file such asversion.1.2.zip
(very handy!)- You can see if a variable is defined in the CACHE with
DEFINED CACHE{VAR}
in anif
statement. BUILD_RPATH_USE_ORIGIN
and CMake version were added to improve handling of RPath in the build directory.- The CMake server mode is now being replaced with a file API, starting in this release. Will affect IDEs in the long run.
CMake 3.13 : Linking control
You can now make symbolic links on Windows! Lots of new functions that fill out the
popular requests for CMake, such as add_link_options
, target_link_directories
, and
target_link_options
. You can now do quite a bit more modification to targets outside
of the source directory, for better file separation. And, target_sources
finally handles relative paths properly (policy 76).
- Initially released November 20, 2018
- New
ctest --progress
option for live output target_link_options
andadd_link_options
addedtarget_link_directories
added- Symbolic link creation,
-E create_symlink
, supported on Windows - IPO supported on Windows
- You can use
-S
and-B
for source and build directories target_link_libraries
andinstall
work outside the current target directorySTATIC_LIBRARY_OPTIONS
property addedtarget_sources
is now relative to the current source directory (CMP0076)- If you use Xcode, you now can experimentally set schema fields
CMake 3.12 : Version ranges and CONFIGURE_DEPENDS
Very powerful release, containing lots of smaller long-requested features. One of the smaller
but immediately noticeable changes is the addition of version ranges;
you can now set both the minimum and maximum known CMake version easily. You can also set
CONFIGURE_DEPENDS
on a GLOB
ed set of files, and the build system will check those files and
rerun if needed! You can use the general PackageName_ROOT
for all find_package
searches. Lots of additions to strings and lists, module updates,
shiny new Python find module (2 and 3 versions too), and many more.
- Initially released July 17, 2018
- Support for
cmake_minimum_required
ranges (backward compatible) - Support for
-j,--parallel
in--build
mode (passed on to build tool) - Support for
SHELL:
strings in compile options (not deduplicated) - New FindPython module
string(JOIN
andlist(JOIN
, andlist(TRANSFORM
file(TOUCH
andfile(GLOB CONFIGURE_DEPENDS
- C++20 support
- CUDA as a language improvements: CUDA 7 and 7.5 now supported
- Support for OpenMP on macOS (command line only)
- Several new properties and property initializers
- CPack finally reads
CMAKE_PROJECT_VERSION
variables
CMake 3.11 : Faster & IMPORTED INTERFACE
This release is supposed to be much faster. You can also finally directly add INTERFACE targets
to IMPORTED libraries (the internal Find*.cmake
scripts should become much cleaner eventually).
- Initially released March 28, 2018
- Fortran supports compiler launchers
- Xcode and Visual Studio support
COMPILE_LANGUAGE
generator expressions finally - You can now add INTERFACE targets directly to IMPORTED INTERFACE libraries (Wow!)
- Source file properties have been expanded
FetchContent
module now allows downloads to happen at configure time (Wow)
CMake 3.10 : CppCheck
CMake now is built with C++11 compilers. Lots of useful improvements help write cleaner code.
- Initially released November 20, 2017
- Support for flang Fortran compiler
- Compiler launcher added to CUDA
- Indented
#cmakedefines
now supported forconfigure_file
include_guard()
added to ensure a file gets included only oncestring(PREPEND
added*_CPPCHECK
property addedLABELS
added to directories- FindMPI vastly expanded
- FindOpenMP improved
- Dynamic test discovery for
GoogleTest
cmake_host_system_information
can access much more information.
CMake 3.9 : IPO
Lots of fixes to CUDA support went into this release, including PTX
support and MSVC generators. Interprocedural Optimizations are now supported properly.
Even more modules provide imported targets, including MPI.
- Initially released July 18, 2017
- CUDA supported for Windows
- Better object library support in several situations
DESCRIPTION
added toproject
separate_arguments
getsNATIVE_COMMAND
INTERPROCEDURAL_OPTIMIZATION
enforced (andCMAKE_*
initializer added, CheckIPOSupported added, Clang and GCC support)- New
GoogleTest
module FindDoxygen
drastically improved
CMake 3.8 : C# & CUDA
This adds CUDA as a language, as well as cxx_std_11
as a compiler meta-feature. The new generator expression could be really useful if you can require CMake 3.8+!
- Initially released April 10, 2017
- Native support for C# as a language
- Native support for CUDA as a language
- Meta features cxx_std_11 (and 14, 17) added
try_compile
has better language supportBUILD_RPATH
property addedCOMPILE_FLAGS
now supports generator expression*_CPPLINT
added$<IF:cond,true-value,false-value>
added (wow!)source_group(TREE
added (finally allowing IDEs to reflect the project folder structure!)
CMake 3.7 : Android & CMake Server
You can now cross-compile to Android. Useful new if statement options really help clarify code. And the new server mode was supposed to improve integration with IDEs (but is being replaced by a different system in CMake 3.14+). Support for the VIM editor was also improved.
- Initially released November 11, 2016
PARSE_ARGV
mode forcmake_parse_arguments
- Better 32-bit support on 64-bit machines
- Lots of useful new if comparisons, like
VERSION_GREATER_EQUAL
(really, why did it take this long?) LINK_WHAT_YOU_USE
added- Lots of custom properties related to files and directories
- CMake Server added
- Added
--trace-source="filename"
to monitor certain files only
CMake 3.6 : Clang-Tidy
This release added Clang-Tidy support, along with more utilities and improvements. It also removed the search of $PATH
on Unix systems due to problems, instead users should use $CMAKE_PREFIX_PATH
.
- Initially released July 7, 2016
EXCLUDE_FROM_ALL
for installlist(FILTER
addedCMAKE_*_STANDARD_INCLUDE_DIRECTORIES
andCMAKE_*_STANDARD_LIBRARIES
added for toolchains- Try-compile improvements
*_CLANG_TIDY
property added- External projects can now be shallow clones, and other improvements
CMake 3.5 : ARM
This release expanded CMake to more platforms, and make warnings easier to control from the command line.
- Initially released March 8, 2016
- Multiple input files supported for several of the
cmake -E
commands. cmake_parse_arguments
now builtin- Boost, GTest, and more now support imported targets
- ARMCC now supported, better support for iOS
- XCode backslash fix
CMake 3.4 : Swift & CCache
This release adds lots of useful tools, support for the Swift language, and the usual improvements. It also started supporting compiler launchers, like CCache.
- Initially released November 12, 2015
- Added
Swift
language - Added
BASE_DIR
toget_filename_component
if(TEST ...)
addedstring(APPEND ...)
addedCMAKE_*_COMPILER_LAUNCHER
added for make and ninjaTARGET_MESSAGES
allow makefiles to print messages after target is completed- Imported targets are beginning to show up in the official
Find*.cmake
files
CMake 3.3 : if IN_LIST
This is notable for the useful IN_LIST
option for if, but it also added better library search using $PATH
(See CMake 3.6), dependencies for INTERFACE libraries, and several other useful improvements. The addition of a COMPILE_LANGUAGE
generator expression would prove very useful in the future as more languages are added. Makefiles now produce better output in parallel.
- Initially released July 23, 2015
IN_LIST
added toif
*_INCLUDE_WHAT_YOU_USE
property addedCOMPILE_LANGUAGE
generator expression (limited support in some generators)
CMake 3.2 : UTF8
This is a smaller release, with mostly small features and fixes. Internal changes, like better Windows and UTF8 support, were the focus.
- Initially released March 11, 2015
continue()
inside loops- File and directory locks added
CMake 3.1 : C++11 and compile features
This is the first release of CMake to support C++11. Combined with fixes to the new features of CMake 3.0, this is currently a common minimum version of CMake for libraries that want to support old CMake builds.
- Initially released December 17, 2014
- C++11 Support
- Compile features support
- Sources can be added later with
target_sources
- Better support for generator expressions and INTERFACE targets
CMake 3.0 : Interface libraries
There were a ton of additions to this version of CMake, primarily to fill out the target interface. Some bits of needed functionality were missed and implemented in CMake 3.1 instead.
- Initially released June 10, 2014
- New documentation
- INTERFACE libraries
- Project VERSION support
- Exporting build trees easily
- Bracket arguments and comments available (not widely used)
- Lots of improvements