Help: Consolidate 3.5 release notes

Move all development release notes into a new version-specific document:

 tail -q -n +3 Help/release/dev/* > Help/release/3.5.rst
 git rm -- Help/release/dev/*

except the sample topic:

 git checkout HEAD -- Help/release/dev/0-sample-topic.rst

Reference the new document from the release notes index document.
Add a title and intro sentence to the new document by hand.
This commit is contained in:
Brad King 2016-02-01 12:47:27 -05:00
parent adc3d1244b
commit 377a12b2d2
35 changed files with 154 additions and 211 deletions

153
Help/release/3.5.rst Normal file
View File

@ -0,0 +1,153 @@
CMake 3.5 Release Notes
***********************
.. only:: html
.. contents::
Changes made since CMake 3.4 include the following.
* Support was added for the ARM Compiler (arm.com) with compiler id ``ARMCC``.
* A new platform file for cross-compiling in the Cray Linux Environment to
target compute nodes was added. See
:ref:`Cross Compiling for the Cray Linux Environment <Cray Cross-Compile>`
for usage details.
* The :module:`CPackDMG` module learned new variable to specify AppleScript
file run to customize appearance of ``DragNDrop`` installer folder,
including background image setting using supplied PNG or multi-resolution
TIFF file. See the :variable:`CPACK_DMG_DS_STORE_SETUP_SCRIPT` and
:variable:`CPACK_DMG_BACKGROUND_IMAGE` variables.
* The :manual:`cmake(1)` ``-E copy`` and ``-E copy_if_different`` command-line
tools learned to support copying multiple input files to a directory.
* The :manual:`cmake(1)` ``-E copy_directory`` command-line
tool learned to support copying multiple input directories to a directory.
* The :manual:`cmake(1)` ``-E make_directory`` command-line
tool learned to support copying multiple input directories to a directory.
* The :manual:`cmake(1)` ``-E time`` command now properly passes arguments
with spaces or special characters through to the child process. This
may break scripts that worked around the bug with their own extra
quoting or escaping.
* The :manual:`cmake-gui(1)` learned an option to set the toolset
to be used with VS IDE and Xcode generators, much like the
existing ``-T`` option to :manual:`cmake(1)`.
* The :command:`cmake_parse_arguments` command is now implemented natively.
The :module:`CMakeParseArguments` module remains as an empty placeholder
for compatibility.
* The :variable:`CMAKE_WARN_DEPRECATED` variable can now be set using the
``-Wdeprecated`` and ``-Wno-deprecated`` :manual:`cmake(1)` options.
* The ``-Wdev`` and ``-Wno-dev`` :manual:`cmake(1)` options now also enable
and suppress the deprecated warnings output by default.
* Warnings about deprecated functionality are now enabled by default.
They may be suppressed with ``-Wno-deprecated`` or by setting the
:variable:`CMAKE_WARN_DEPRECATED` variable to false.
* Warnings about deprecated functionality can now be controlled in the
:manual:`cmake-gui(1)` application.
* The suppression of developer warnings as errors can now be controlled with
the new ``-Werror=dev`` and ``-Wno-error=dev`` :manual:`cmake(1)` options.
* The :variable:`CMAKE_ERROR_DEPRECATED` variable can now be set using the
``-Werror=deprecated`` and ``-Wno-error=deprecated`` :manual:`cmake(1)`
options.
* The :module:`CPackDeb` module learned to set optional config
file ``Source`` field - monolithic and per-component variable.
See :variable:`CPACK_DEBIAN_PACKAGE_SOURCE`.
* The :module:`CPackDeb` module learned to set Package, Section
and Priority control fields per-component.
See :variable:`CPACK_DEBIAN_<COMPONENT>_PACKAGE_SECTION`
and :variable:`CPACK_DEBIAN_<COMPONENT>_PACKAGE_PRIORITY`.
* The :module:`CPack DragNDrop generator <CPackDMG>` learned to add
multi-lingual SLAs to a DMG which is presented to the user when they try to
mount the DMG. See the :variable:`CPACK_DMG_SLA_LANGUAGES` and
:variable:`CPACK_DMG_SLA_DIR` variables for details.
* The :module:`CPackNSIS` module learned new variables to add bitmaps to the
installer. See the :variable:`CPACK_NSIS_MUI_WELCOMEFINISHPAGE_BITMAP`
and :variable:`CPACK_NSIS_MUI_UNWELCOMEFINISHPAGE_BITMAP` variables.
* The :module:`CPackRPM` module learned to set Name and Group
control fields per-component.
See :variable:`CPACK_RPM_<component>_PACKAGE_NAME`
and :variable:`CPACK_RPM_<component>_PACKAGE_GROUP`.
* The :module:`CMakeForceCompiler` module and its macros are now deprecated.
See module documentation for an explanation.
* The :module:`ExternalProject` module learned a new ``GIT_REMOTE_NAME``
option to control the ``git clone --origin`` value.
* The :module:`FindBoost` module now provides imported targets
such as ``Boost::boost`` and ``Boost::filesystem``.
* The :module:`FindFLEX` module ``FLEX_TARGET`` macro learned a
new ``DEFINES_FILE`` option to specify a custom output header
to be generated.
* The :module:`FindGTest` module now provides imported targets.
* The :module:`FindGTK2` module, when ``GTK2_USE_IMPORTED_TARGETS`` is
enabled, now sets ``GTK2_LIBRARIES`` to contain the list of imported
targets instead of the paths to the libraries. Moreover it now sets
a new ``GTK2_TARGETS`` variable containing all the targets imported.
* Starting with sigc++ 2.5.1, c++11 must be enabled in order to use
sigc++. The GTK2::sigc++ imported target will automatically enable the
required build flags in order to build with the version found on the
system.
* The :module:`FindOpenMP` module learned to support Clang.
* The :module:`FindOpenSSL` module gained a new
``OPENSSL_MSVC_STATIC_RT`` option to search for libraries using
the MSVC static runtime.
* The :module:`FindPNG` module now provides imported targets.
* The :module:`FindTIFF` module now provides imported targets.
* A :module:`FindXalanC` module was introduced to find the
Apache Xalan-C++ XSL transform processing library.
* The :module:`FindXercesC` module now provides imported targets.
* The :command:`install(DIRECTORY)` command learned to support
:manual:`generator expressions <cmake-generator-expressions(7)>`
in the list of directories.
* When building for embedded Apple platforms like iOS CMake learned to build and
install combined targets which contain both a device and a simulator build.
This behavior can be enabled by setting the :prop_tgt:`IOS_INSTALL_COMBINED`
target property.
* The :manual:`Compile Features <cmake-compile-features(7)>` functionality
is now aware of features supported by Clang compilers on Windows (MinGW).
* The Qt base CMake GUI got a Regular Expression Explorer which could be used to
create and evaluate regular expressions in real-time. The explorer window
is available via the ``Tools`` menu.
* The precompiled Windows binary provided on ``cmake.org`` is now a
``.msi`` package instead of an installer executable. One may need
to manually uninstall CMake versions lower than 3.5 before installing
the new package.
* The :generator:`Visual Studio 14 2015` generator learned to map the
``/debug:fastlink`` linker flag to the ``.vcxproj`` file property.
* The :prop_tgt:`VS_GLOBAL_<variable>` target property is now implemented
for VS 2010 and above. Previously it worked only in VS 2008 and below.

View File

@ -1,6 +0,0 @@
CMakeParseArguments-native-impl
-------------------------------
* The :command:`cmake_parse_arguments` command is now implemented natively.
The :module:`CMakeParseArguments` module remains as an empty placeholder
for compatibility.

View File

@ -1,5 +0,0 @@
ExternalProject-git-clone-o
---------------------------
* The :module:`ExternalProject` module learned a new ``GIT_REMOTE_NAME``
option to control the ``git clone --origin`` value.

View File

@ -1,5 +0,0 @@
FindBoost-imported-targets
--------------------------
* The :module:`FindBoost` module now provides imported targets
such as ``Boost::boost`` and ``Boost::filesystem``.

View File

@ -1,6 +0,0 @@
FindFLEX-DEFINES_FILE
---------------------
* The :module:`FindFLEX` module ``FLEX_TARGET`` macro learned a
new ``DEFINES_FILE`` option to specify a custom output header
to be generated.

View File

@ -1,7 +0,0 @@
FindGTK2_GTK2_TARGETS
---------------------
* The :module:`FindGTK2` module, when ``GTK2_USE_IMPORTED_TARGETS`` is
enabled, now sets ``GTK2_LIBRARIES`` to contain the list of imported
targets instead of the paths to the libraries. Moreover it now sets
a new ``GTK2_TARGETS`` variable containing all the targets imported.

View File

@ -1,7 +0,0 @@
FindGTK2_sigc++_c++11
---------------------
* Starting with sigc++ 2.5.1, c++11 must be enabled in order to use
sigc++. The GTK2::sigc++ imported target will automatically enable the
required build flags in order to build with the version found on the
system.

View File

@ -1,4 +0,0 @@
FindGTest-imported-targets
--------------------------
* The :module:`FindGTest` module now provides imported targets.

View File

@ -1,4 +0,0 @@
FindOpenMP-clang
----------------
* The :module:`FindOpenMP` module learned to support Clang.

View File

@ -1,6 +0,0 @@
FindOpenSSL-msvc-static-rt
--------------------------
* The :module:`FindOpenSSL` module gained a new
``OPENSSL_MSVC_STATIC_RT`` option to search for libraries using
the MSVC static runtime.

View File

@ -1,4 +0,0 @@
FindPNG-imported-targets
------------------------
* The :module:`FindPNG` module now provides imported targets.

View File

@ -1,4 +0,0 @@
FindTIFF-imported-targets
-------------------------
* The :module:`FindTIFF` module now provides imported targets.

View File

@ -1,5 +0,0 @@
FindXalanC
----------
* A :module:`FindXalanC` module was introduced to find the
Apache Xalan-C++ XSL transform processing library.

View File

@ -1,4 +0,0 @@
FindXercesC-imported-targets
----------------------------
* The :module:`FindXercesC` module now provides imported targets.

View File

@ -1,4 +0,0 @@
add-armcc-toolchain
-------------------
* Support was added for the ARM Compiler (arm.com) with compiler id ``ARMCC``.

View File

@ -1,7 +0,0 @@
add-cray-linux-platform
-----------------------
* A new platform file for cross-compiling in the Cray Linux Environment to
target compute nodes was added. See
:ref:`Cross Compiling for the Cray Linux Environment <Cray Cross-Compile>`
for usage details.

View File

@ -1,8 +0,0 @@
better-looking-mac-packages
---------------------------
* The :module:`CPackDMG` module learned new variable to specify AppleScript
file run to customize appearance of ``DragNDrop`` installer folder,
including background image setting using supplied PNG or multi-resolution
TIFF file. See the :variable:`CPACK_DMG_DS_STORE_SETUP_SCRIPT` and
:variable:`CPACK_DMG_BACKGROUND_IMAGE` variables.

View File

@ -1,11 +0,0 @@
cmake-E-multiple-inputs
-----------------------
* The :manual:`cmake(1)` ``-E copy`` and ``-E copy_if_different`` command-line
tools learned to support copying multiple input files to a directory.
* The :manual:`cmake(1)` ``-E copy_directory`` command-line
tool learned to support copying multiple input directories to a directory.
* The :manual:`cmake(1)` ``-E make_directory`` command-line
tool learned to support copying multiple input directories to a directory.

View File

@ -1,7 +0,0 @@
cmake-E-time-quoting
--------------------
* The :manual:`cmake(1)` ``-E time`` command now properly passes arguments
with spaces or special characters through to the child process. This
may break scripts that worked around the bug with their own extra
quoting or escaping.

View File

@ -1,22 +0,0 @@
cmake-W-options
---------------
* The :variable:`CMAKE_WARN_DEPRECATED` variable can now be set using the
``-Wdeprecated`` and ``-Wno-deprecated`` :manual:`cmake(1)` options.
* The ``-Wdev`` and ``-Wno-dev`` :manual:`cmake(1)` options now also enable
and suppress the deprecated warnings output by default.
* Warnings about deprecated functionality are now enabled by default.
They may be suppressed with ``-Wno-deprecated`` or by setting the
:variable:`CMAKE_WARN_DEPRECATED` variable to false.
* Warnings about deprecated functionality can now be controlled in the
:manual:`cmake-gui(1)` application.
* The suppression of developer warnings as errors can now be controlled with
the new ``-Werror=dev`` and ``-Wno-error=dev`` :manual:`cmake(1)` options.
* The :variable:`CMAKE_ERROR_DEPRECATED` variable can now be set using the
``-Werror=deprecated`` and ``-Wno-error=deprecated`` :manual:`cmake(1)`
options.

View File

@ -1,6 +0,0 @@
cmake-gui-select-toolset
------------------------
* The :manual:`cmake-gui(1)` learned an option to set the toolset
to be used with VS IDE and Xcode generators, much like the
existing ``-T`` option to :manual:`cmake(1)`.

View File

@ -1,6 +0,0 @@
cpack-deb-config-file-source-field
----------------------------------
* The :module:`CPackDeb` module learned to set optional config
file ``Source`` field - monolithic and per-component variable.
See :variable:`CPACK_DEBIAN_PACKAGE_SOURCE`.

View File

@ -1,7 +0,0 @@
cpack-deb-new-component-vars
----------------------------
* The :module:`CPackDeb` module learned to set Package, Section
and Priority control fields per-component.
See :variable:`CPACK_DEBIAN_<COMPONENT>_PACKAGE_SECTION`
and :variable:`CPACK_DEBIAN_<COMPONENT>_PACKAGE_PRIORITY`.

View File

@ -1,7 +0,0 @@
cpack-dmg-multilanguage-sla
---------------------------
* The :module:`CPack DragNDrop generator <CPackDMG>` learned to add
multi-lingual SLAs to a DMG which is presented to the user when they try to
mount the DMG. See the :variable:`CPACK_DMG_SLA_LANGUAGES` and
:variable:`CPACK_DMG_SLA_DIR` variables for details.

View File

@ -1,6 +0,0 @@
cpack-nsis-bitmap
-----------------
* The :module:`CPackNSIS` module learned new variables to add bitmaps to the
installer. See the :variable:`CPACK_NSIS_MUI_WELCOMEFINISHPAGE_BITMAP`
and :variable:`CPACK_NSIS_MUI_UNWELCOMEFINISHPAGE_BITMAP` variables.

View File

@ -1,7 +0,0 @@
cpack-rpm-percomponent-group-and-name
-------------------------------------
* The :module:`CPackRPM` module learned to set Name and Group
control fields per-component.
See :variable:`CPACK_RPM_<component>_PACKAGE_NAME`
and :variable:`CPACK_RPM_<component>_PACKAGE_GROUP`.

View File

@ -1,5 +0,0 @@
deprecate-CMakeForceCompiler
----------------------------
* The :module:`CMakeForceCompiler` module and its macros are now deprecated.
See module documentation for an explanation.

View File

@ -1,6 +0,0 @@
install-DIRECTORY-genex
-----------------------
* The :command:`install(DIRECTORY)` command learned to support
:manual:`generator expressions <cmake-generator-expressions(7)>`
in the list of directories.

View File

@ -1,7 +0,0 @@
ios-universal
-------------
* When building for embedded Apple platforms like iOS CMake learned to build and
install combined targets which contain both a device and a simulator build.
This behavior can be enabled by setting the :prop_tgt:`IOS_INSTALL_COMBINED`
target property.

View File

@ -1,5 +0,0 @@
mingw-clang-compile-features
----------------------------
* The :manual:`Compile Features <cmake-compile-features(7)>` functionality
is now aware of features supported by Clang compilers on Windows (MinGW).

View File

@ -1,6 +0,0 @@
regex-explorer
--------------
* The Qt base CMake GUI got a Regular Expression Explorer which could be used to
create and evaluate regular expressions in real-time. The explorer window
is available via the ``Tools`` menu.

View File

@ -1,7 +0,0 @@
release-windows
---------------
* The precompiled Windows binary provided on ``cmake.org`` is now a
``.msi`` package instead of an installer executable. One may need
to manually uninstall CMake versions lower than 3.5 before installing
the new package.

View File

@ -1,5 +0,0 @@
vs-debug-fastlink
-----------------
* The :generator:`Visual Studio 14 2015` generator learned to map the
``/debug:fastlink`` linker flag to the ``.vcxproj`` file property.

View File

@ -1,5 +0,0 @@
vs-global-properties
--------------------
* The :prop_tgt:`VS_GLOBAL_<variable>` target property is now implemented
for VS 2010 and above. Previously it worked only in VS 2008 and below.

View File

@ -13,6 +13,7 @@ Releases
.. toctree::
:maxdepth: 1
3.5 <3.5>
3.4 <3.4>
3.3 <3.3>
3.2 <3.2>