summaryrefslogtreecommitdiffstats
path: root/Help/release
diff options
context:
space:
mode:
authorCraig Scott <craig.scott@crascit.com>2022-04-29 07:43:03 (GMT)
committerCraig Scott <craig.scott@crascit.com>2022-04-29 14:28:05 (GMT)
commitd099136addaf5e9672e892ad2cb1c43809f7174b (patch)
tree21fba5692c4e988cb27ef19e2086386ce73d0864 /Help/release
parent74c4762a3884ac938106d412a5ea8ea7b248f9ca (diff)
downloadCMake-d099136addaf5e9672e892ad2cb1c43809f7174b.zip
CMake-d099136addaf5e9672e892ad2cb1c43809f7174b.tar.gz
CMake-d099136addaf5e9672e892ad2cb1c43809f7174b.tar.bz2
productbuild: Restore CPACK_PACKAGEMAKER_CHOICES variable
In 2a8df7e7db (productbuild: Don't write rootVolumeOnly attribute if writing domains, 2022-03-21), the variable holding the main contents of the distribution.dist XML file was renamed from CPACK_PACKAGEMAKER_CHOICES to CPACK_APPLE_PKG_INSTALLER_CONTENT. This reflected the fact that the PackageMaker generator is deprecated. The new variable also includes more details than the old one held. Some projects were relying on the old variable name, so we need to still set that to the same contents as it would have previously provided. Neither of these variables were previously documented, but the older variable was mentioned in enough semi-official places that it essentially became semi-supported. Document both variables and highlight that the older one is deprecated. Fixes: #23467
Diffstat (limited to 'Help/release')
-rw-r--r--Help/release/3.23.rst27
1 files changed, 27 insertions, 0 deletions
diff --git a/Help/release/3.23.rst b/Help/release/3.23.rst
index 2febbec..47c4243 100644
--- a/Help/release/3.23.rst
+++ b/Help/release/3.23.rst
@@ -185,6 +185,13 @@ CPack
:variable:`CPACK_PRODUCTBUILD_IDENTIFIER`, used to customize the unique
product identifier associated with the product.
+* The ``CPack.distribution.dist.in`` template used by the
+ :cpack_gen:`CPack productbuild Generator` and
+ :cpack_gen:`CPack PackageMaker Generator` was updated to use a new
+ ``CPACK_APPLE_PKG_INSTALLER_CONTENT`` variable for its main content.
+ This replaced the previously undocumented and now deprecated
+ ``CPACK_PACKAGEMAKER_CHOICES`` variable.
+
* The :cpack_gen:`CPack IFW Generator` gained the new
:variable:`CPACK_IFW_ARCHIVE_FORMAT` and
:variable:`CPACK_IFW_ARCHIVE_COMPRESSION` variables for setting the
@@ -230,6 +237,15 @@ Deprecated and Removed Features
* The :manual:`cpack(1)` undocumented ``OSXX11`` generator has been removed.
+* The previously undocumented ``CPACK_PACKAGEMAKER_CHOICES`` variable used in
+ the ``CPack.distribution.dist.in`` template has been replaced by a new
+ ``CPACK_APPLE_PKG_INSTALLER_CONTENT`` variable. This only affects projects
+ that were providing their own custom ``CPack.distribution.dist.in`` template
+ file, but still relied on ``CPACK_PACKAGEMAKER_CHOICES`` being set. Those
+ custom template files should be updated to use
+ ``CPACK_APPLE_PKG_INSTALLER_CONTENT`` instead, or to fully define all the
+ template file's contents without relying on substitution of either variable.
+
Other Changes
=============
@@ -282,3 +298,14 @@ Changes made since CMake 3.23.0 include the following.
* The :prop_tgt:`HEADER_SETS` and :prop_tgt:`INTERFACE_HEADER_SETS` target
properties added in CMake 3.23.0 are now read-only records of the header
sets created by the :command:`target_sources` command.
+
+3.23.2
+------
+
+* The ``CPACK_PACKAGEMAKER_CHOICES`` variable used in the
+ ``CPack.distribution.dist.in`` template file was replaced by a new
+ ``CPACK_APPLE_PKG_INSTALLER_CONTENT`` variable in CMake 3.23.0.
+ This broke projects that provided their own template file but still
+ expected the ``CPACK_PACKAGEMAKER_CHOICES`` variable to be defined.
+ The old ``CPACK_PACKAGEMAKER_CHOICES`` variable is now also set to the
+ same content as it was before, but it is formally deprecated.