1
0
mirror of https://github.com/Kitware/CMake.git synced 2025-10-14 02:08:27 +08:00

Help: Organize and revise 4.2 release notes

Add section headers similar to the 4.1 release notes and move each
individual bullet into an appropriate section.  Revise a few bullets.
This commit is contained in:
Brad King
2025-10-08 11:49:38 -04:00
parent ec28123cb4
commit 5c7e90d954

View File

@@ -7,22 +7,11 @@ CMake 4.2 Release Notes
Changes made since CMake 4.1 include the following.
* The :module:`CheckTypeSize` module's command :command:`check_type_size`
gained a new argument ``RESULT_VARIABLE`` to customize the result variable
name instead of the default ``HAVE_<size-var>``.
New Features
============
* The :manual:`cmake(1)` command-line tool now supports
``cmake -E copy_if_newer`` and ``cmake -E copy_directory_if_newer``
subcommands to copy files based on timestamp comparison instead of
content comparison. These commands copy files only if the source is
newer than the destination, providing better performance for build
systems compared to ``copy_if_different`` which compares file contents.
* The :command:`cmake_language` command gained a new ``TRACE`` subcommand
to enable or disable tracing during script execution.
* :variable:`CMAKE_PARENT_LIST_FILE` is no longer defined when processing
a ``CMakeLists.txt`` file. See policy :policy:`CMP0198`.
File-Based API
--------------
* The :manual:`cmake-file-api(7)` "codemodel" version 2 ``version`` field has
been updated to 2.9.
@@ -30,37 +19,6 @@ Changes made since CMake 4.1 include the following.
* The :manual:`cmake-file-api(7)` "codemodel" version 2 "target" and
"directory" objects gained a new ``codemodelVersion`` field.
The :genex:`$<CONFIG:cfgs>` generator expression no longer matches multiple
configurations. See policy :policy:`CMP0199`.
* The :cpack_gen:`CPack NSIS Generator` gained a new
:variable:`CPACK_NSIS_CRC_CHECK` variable for setting the ``CRCCheck``
attribute.
* :variable:`CPACK_PACKAGE_CHECKSUM` now supports multiple values.
* The ``import std`` support learned to use the
:variable:`CMAKE_CXX_STDLIB_MODULES_JSON` variable to set the path to the
metadata file for the standard library rather than using the compiler to
discover its location.
* For builds targeting the MSVC ABI, all generators now add the ``_MBCS``
preprocessor definition when compiling sources unless ``_UNICODE`` or ``_SBCS``
is found. See policy :policy:`CMP0204`.
* For builds targeting the MSVC ABI, all generators now add the ``_WINDLL``
preprocessor definition when compiling sources in shared libraries.
See policy :policy:`CMP0203`.
* CMake now supports :ref:`Cross Compiling for Emscripten` with simple
toolchain files.
* The :module:`ExternalProject` module's commands :command:`ExternalProject_Add`
and :command:`ExternalProject_Add_Step` now provide options to set
environment variables on the configure, build, install, and test steps.
* The :generator:`FASTBuild` generator was added.
* The :manual:`cmake-file-api(7)` "codemodel" version 2 now includes imported
targets and all interface library targets in its replies. Previously,
imported targets were omitted, and only those interface targets that
@@ -81,29 +39,118 @@ configurations. See policy :policy:`CMP0199`.
``interfaceCompileDependencies``, ``objectDependencies``, and
``orderDependencies`` fields.
* The :module:`FindDevIL` module now provides a ``DevIL_VERSION`` result
variable and version argument and version range can be specified by
:command:`find_package`, when finding the DevIL package.
Generators
----------
* The uppercased ``<PACKAGENAME>_FOUND`` result variables of find modules
are now deprecated in favor of ``<PackageName>_FOUND`` result variables,
where appropriate. See documentation of each find module for details.
* The :generator:`Visual Studio 18 2026` generator was added. This is
experimental and based on "Visual Studio 2026 Insiders" because this
version of VS has not been released.
* The :generator:`FASTBuild` generator was added.
Platforms
---------
* CMake now supports :ref:`Cross Compiling for Emscripten` with simple
toolchain files.
Command-Line
------------
* The :manual:`cmake(1)` command-line tool now supports
``cmake -E copy_if_newer`` and ``cmake -E copy_directory_if_newer``
subcommands to copy files based on timestamp comparison instead of
content comparison. These commands copy files only if the source is
newer than the destination, providing better performance for build
systems compared to ``copy_if_different`` which compares file contents.
Commands
--------
* The :command:`cmake_language(TRACE)` command was added to enable or
disable tracing during script execution.
* The :command:`set(CACHE{<variable>}) <set(CACHE)>` and
:command:`unset(CACHE{<variable>}) <unset(CACHE)>` commands were added to
explicitly set and unset cache entries.
* The :command:`string(REGEX QUOTE)` command was added to
generate a regular expression exactly matching a string.
Variables
---------
* The :variable:`CMAKE_CXX_STDLIB_MODULES_JSON` variable was added to set
the path to the ``import std`` metadata file for the standard library
rather than using the compiler to discover its location.
* The :variable:`CMAKE_INTERMEDIATE_DIR_STRATEGY` variable and corresponding
:envvar:`CMAKE_INTERMEDIATE_DIR_STRATEGY` environment variable were added
to change the strategy used to name intermediate directories used for
object files and other associated target metadata.
* The :variable:`CMAKE_AUTOGEN_INTERMEDIATE_DIR_STRATEGY` variable and
corresponding :envvar:`CMAKE_AUTOGEN_INTERMEDIATE_DIR_STRATEGY` environment
variable were added to change the strategy used to name intermediate
directories used for :manual:`Qt Autogen <cmake-qt(7)>` files.
* The :variable:`CMAKE_SKIP_LINTING` variable and corresponding
:prop_tgt:`SKIP_LINTING` target property were added to tell the
:ref:`Command-Line Build Tool Generators` to skip linting all
sources in a target.
Properties
----------
* The :prop_sf:`INSTALL_OBJECT_NAME` source file property was added to
control names of installed object files for specific compiled sources.
* The :prop_tgt:`INSTALL_OBJECT_NAME_STRATEGY` target property was added
to control the naming strategy for installed object files.
* The :prop_tgt:`INSTALL_OBJECT_ONLY_USE_DESTINATION` target property was
added to more precisely control the installation path for object files.
* The :prop_sf:`JOB_POOL_COMPILE` source file property was added
to assign individual source compilations to :prop_gbl:`JOB_POOLS`.
* The :prop_sf:`OBJECT_NAME` source file property was added to control
object names of compiled source files.
* The :prop_tgt:`UNITY_BUILD_FILENAME_PREFIX` target property was added
to control names of source files generated by :prop_tgt:`UNITY_BUILD`.
Modules
-------
* Nearly all find modules now provide a ``<PackageName>_VERSION`` result
variable matching the casing of its module name. Existing variants such as
``<PackageName>_VERSION_STRING`` and uppercased ``<PACKAGENAME>_VERSION``
are deprecated. See documentation of each find module for details.
* The :module:`FindwxWidgets` module's result variable
``wxWidgets_USE_FILE`` is now deprecated in favor of including the
:module:`UsewxWidgets` module directly.
* The :module:`CheckTypeSize` module's :command:`check_type_size` command
gained a new ``RESULT_VARIABLE`` keyword to customize the result variable
name instead of the default ``HAVE_<size-var>``.
* The :command:`find_package()` command gained a new ``UNWIND_INCLUDE`` option
to enable immediate :command:`return` from :command:`include()` commands
after a failure to discover a transitive dependency.
* The :module:`ExternalProject` module's :command:`ExternalProject_Add`
and :command:`ExternalProject_Add_Step` commands now provide options to set
environment variables on the configure, build, install, and test steps.
* The ``Python::NumPy`` target does not depend on
the ``Python::Development.Module`` target. See policy :policy:`CMP0201`.
* The :module:`FindPython3`, :module:`FindPython2`, and :module:`FindPython`
modules no longer make ``NumPy`` depend on ``Development.Module``.
See policy :policy:`CMP0201`.
* The :module:`GoogleTest` module's :command:`gtest_discover_tests()`
command now sets the ``DEF_SOURCE_LINE`` test property for each
discovered test if gtest supports the ``--gtest_output=json`` option.
This test property is used by some IDEs to locate the source for each test.
* The :module:`UseSWIG` module's :command:`swig_add_library` command gained a
``DEBUG_POSTFIX`` option to control the :prop_tgt:`DEBUG_POSTFIX` target
property.
Generator Expressions
---------------------
* The :genex:`<LANG>_COMPILER_LINKER_ID <C_COMPILER_LINKER_ID>` and
:genex:`<LANG>_COMPILER_LINKER_FRONTEND_VARIANT <C_COMPILER_LINKER_FRONTEND_VARIANT>`
@@ -116,78 +163,57 @@ configurations. See policy :policy:`CMP0199`.
:genex:`TARGET_LINKER_LIBRARY_FILE_BASE_NAME`,
:genex:`TARGET_LINKER_IMPORT_FILE_BASE_NAME`, and
:genex:`TARGET_PDB_FILE_BASE_NAME`
generator expressions gained the option ``POSTFIX`` to control the inclusion
or not of the :prop_tgt:`<CONFIG>_POSTFIX` target property as part of the
base name of the target.
generator expressions gained a ``POSTFIX`` option to control the inclusion
of the :prop_tgt:`<CONFIG>_POSTFIX` target property as part of the base
names of the corresponding files.
* The :genex:`TARGET_INTERMEDIATE_DIR` generator expression was
added to refer to a target's intermediate files directory in
the build tree.
* The :command:`gtest_discover_tests()` command from the :module:`GoogleTest`
module now sets the ``DEF_SOURCE_LINE`` test property for each discovered
test if gtest supports the ``--gtest_output=json`` option. This test
property is used by some IDEs to locate the source for each test.
* The :command:`gtest_discover_tests()` command from the :module:`GoogleTest`
module previously parsed certain type-parameterized test names incorrectly.
Their names ended up with raw characters from gtest's output and were
very obviously misparsed. Those names are now parsed correctly, so projects
may see different test names to before for affected tests.
CPack
-----
Location and configuration selection for imported targets is now more
consistent. See policy :policy:`CMP0200`.
* The :variable:`CPACK_PACKAGE_CHECKSUM` variable now supports multiple values.
* The :prop_tgt:`INSTALL_OBJECT_NAME_STRATEGY` target property has been added
to control the naming strategy for installed object files.
* The :cpack_gen:`CPack NSIS Generator` gained a
:variable:`CPACK_NSIS_CRC_CHECK` variable for setting the ``CRCCheck``
attribute.
* The :prop_tgt:`INSTALL_OBJECT_ONLY_USE_DESTINATION` target property has been
added to more precisely control the installation path for object files.
* The :cpack_gen:`CPack WIX Generator` gained a
:variable:`CPACK_WIX_CAB_PER_COMPONENT` variable to enable one ``.cab``
per component.
* The :prop_sf:`JOB_POOL_COMPILE` source file property was added
to assign individual source compilations to :prop_gbl:`JOB_POOLS`.
Deprecated and Removed Features
===============================
* The :prop_sf:`OBJECT_NAME` source file property may be used to control
object names of source files.
* The uppercased ``<PACKAGENAME>_FOUND`` result variables of find modules
are now deprecated in favor of ``<PackageName>_FOUND`` result variables,
where appropriate. See documentation of each find module for details.
* The :prop_sf:`INSTALL_OBJECT_NAME` source file property may be used to
control names of installed object files.
* The :command:`set` and :command:`unset` commands gain the support of the
``CACHE{<variable>}`` syntax to handle cache entries.
* There is now the :variable:`CMAKE_INTERMEDIATE_DIR_STRATEGY` variable (and
associated environment variable :envvar:`CMAKE_INTERMEDIATE_DIR_STRATEGY`)
that may be used to change the strategy used to name intermediate
directories used for object files (and other associated target metadata).
* There is now the :variable:`CMAKE_AUTOGEN_INTERMEDIATE_DIR_STRATEGY`
variable (and associated environment variable
:envvar:`CMAKE_AUTOGEN_INTERMEDIATE_DIR_STRATEGY`)
that may be used to change the strategy used to name intermediate
directories used for :manual:`Qt Autogen <cmake-qt(7)>` files.
* The :command:`string(REGEX QUOTE)` command was added to
generate a regular expression exactly matching a string.
* The :variable:`CMAKE_SKIP_LINTING` variable and corresponding
:prop_tgt:`SKIP_LINTING` target property were added to tell the
:ref:`Command-Line Build Tool Generators` to skip linting all
sources in a target.
* The :prop_tgt:`UNITY_BUILD_FILENAME_PREFIX` target property was added
to control names of source files generated by :prop_tgt:`UNITY_BUILD`.
* The ``swig_add_library()`` command, from the :module:`UseSWIG` module, gained
the option ``DEBUG_POSTFIX`` for the management of the
:prop_tgt:`DEBUG_POSTFIX` target property.
* The :module:`FindwxWidgets` module's result variable
``wxWidgets_USE_FILE`` is now deprecated in favor of including the
:module:`UsewxWidgets` module directly.
* The :generator:`Visual Studio 14 2015` generator is now deprecated
and will be removed in a future version of CMake.
* The :generator:`Visual Studio 18 2026` generator was added. This is
experimental and based on "Visual Studio 2026 Insiders" because this
version of VS has not been released.
Other Changes
=============
* :variable:`CPACK_WIX_CAB_PER_COMPONENT` allows CPack WIX opt-in generation of one
`.cab` file per component. Having multiple `.cab` files may improve the time it takes
to generate installers and may also work around per `.cab` size constraints.
* The :genex:`$<CONFIG:cfgs>` generator expression no longer matches multiple
configurations. See policy :policy:`CMP0199`.
* Selection of configuration and location of imported targets is now more
consistent. See policy :policy:`CMP0200`.
* The :variable:`CMAKE_PARENT_LIST_FILE` variable is no longer defined when
processing a ``CMakeLists.txt`` file. See policy :policy:`CMP0198`.
* For builds targeting the MSVC ABI, all generators now add the ``_MBCS``
preprocessor definition when compiling sources unless ``_UNICODE`` or
``_SBCS`` is found. See policy :policy:`CMP0204`.
* For builds targeting the MSVC ABI, all generators now add the ``_WINDLL``
preprocessor definition when compiling sources in shared libraries.
See policy :policy:`CMP0203`.