summaryrefslogtreecommitdiffstats
path: root/Help
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2023-11-28 14:45:41 (GMT)
committerKitware Robot <kwrobot@kitware.com>2023-11-28 14:45:53 (GMT)
commitc40e242be39d50c4fc235a6a088efb99ff1916dd (patch)
tree8e11210305515c6262e782f0a4a765e64558baec /Help
parent806c40a38fc6e1996738173ecfa23a26f7502dbf (diff)
parent53991e62daf819a91b7c89f4d4899d0f94c7fd12 (diff)
downloadCMake-c40e242be39d50c4fc235a6a088efb99ff1916dd.zip
CMake-c40e242be39d50c4fc235a6a088efb99ff1916dd.tar.gz
CMake-c40e242be39d50c4fc235a6a088efb99ff1916dd.tar.bz2
Merge topic 'cpack-auto-suffixes'
53991e62da CPack/RPM: Append .rpm to CPACK_RPM_FILE_NAME if missing f2a6d423da CPack/DEB: Append .deb to CPACK_DEBIAN_FILE_NAME if missing 907d4db558 Help: Format allowed CPACK_{DEB,RPM}_FILE_NAME values as definition list Acked-by: Kitware Robot <kwrobot@kitware.com> Acked-by: buildbot <buildbot@kitware.com> Merge-request: !8880
Diffstat (limited to 'Help')
-rw-r--r--Help/cpack_gen/deb.rst34
-rw-r--r--Help/cpack_gen/rpm.rst15
-rw-r--r--Help/release/dev/cpack-auto-suffixes.rst10
3 files changed, 41 insertions, 18 deletions
diff --git a/Help/cpack_gen/deb.rst b/Help/cpack_gen/deb.rst
index 705ec9c..23436de 100644
--- a/Help/cpack_gen/deb.rst
+++ b/Help/cpack_gen/deb.rst
@@ -69,28 +69,32 @@ List of CPack DEB generator specific variables:
:Mandatory: Yes
:Default: ``<CPACK_PACKAGE_FILE_NAME>[-<component>].deb``
- This may be set to ``DEB-DEFAULT`` to allow the CPack DEB generator to generate
- package file name by itself in deb format::
+ This may be set to:
- <PackageName>_<VersionNumber>-<DebianRevisionNumber>_<DebianArchitecture>.deb
+ ``DEB-DEFAULT``
+ Tell CPack to automatically generate the package file name in deb format::
- Alternatively provided package file name must end
- with either ``.deb`` or ``.ipk`` suffix.
+ <PackageName>_<VersionNumber>-<DebianRevisionNumber>_<DebianArchitecture>.deb
- .. versionadded:: 3.10
- ``.ipk`` suffix used by OPKG packaging system.
+ This setting recommended as the preferred behavior, but for backward
+ compatibility with the CPack DEB generator in CMake prior to version 3.6,
+ this is not the default. Without this, duplicate names may occur.
+ Duplicate files get overwritten and it is up to the packager to set
+ the variables in a manner that will prevent such errors.
- .. note::
+ ``<file-name>[.deb]``
+ Use the given file name.
- Preferred setting of this variable is ``DEB-DEFAULT`` but for backward
- compatibility with the CPack DEB generator in CMake prior to version 3.6 this
- feature is disabled by default.
+ .. versionchanged:: 3.29
- .. note::
+ The ``.deb`` suffix will be automatically added if the file name does
+ not end in ``.deb`` or ``.ipk``. Previously the suffix was required.
+
+ ``<file-name>.ipk``
+ .. versionadded:: 3.10
- By using non default filenames duplicate names may occur. Duplicate files
- get overwritten and it is up to the packager to set the variables in a
- manner that will prevent such errors.
+ Use the given file name.
+ The ``.ipk`` suffix is used by the OPKG packaging system.
.. variable:: CPACK_DEBIAN_PACKAGE_EPOCH
diff --git a/Help/cpack_gen/rpm.rst b/Help/cpack_gen/rpm.rst
index 7b91261..4a2ce5f 100644
--- a/Help/cpack_gen/rpm.rst
+++ b/Help/cpack_gen/rpm.rst
@@ -84,9 +84,18 @@ List of CPack RPM generator specific variables:
:Default: ``<CPACK_PACKAGE_FILE_NAME>[-<component>].rpm`` with spaces
replaced by '-'
- This may be set to ``RPM-DEFAULT`` to allow ``rpmbuild`` tool to generate package
- file name by itself.
- Alternatively provided package file name must end with ``.rpm`` suffix.
+ This may be set to:
+
+ ``RPM-DEFAULT``
+ Tell ``rpmbuild`` to automatically generate the package file name.
+
+ ``<file-name>[.rpm]``
+ Use the given file name.
+
+ .. versionchanged:: 3.29
+
+ The ``.rpm`` suffix will be automatically added if missing.
+ Previously the suffix was required.
.. note::
diff --git a/Help/release/dev/cpack-auto-suffixes.rst b/Help/release/dev/cpack-auto-suffixes.rst
new file mode 100644
index 0000000..f3fd2af
--- /dev/null
+++ b/Help/release/dev/cpack-auto-suffixes.rst
@@ -0,0 +1,10 @@
+cpack-auto-suffixes
+-------------------
+
+* The :cpack_gen:`CPack DEB Generator` :variable:`CPACK_DEBIAN_FILE_NAME`
+ variable may now be set without any suffix, and the ``.deb`` suffix
+ will be added automatically.
+
+* The :cpack_gen:`CPack RPM Generator` :variable:`CPACK_RPM_FILE_NAME`
+ variable may now be set without any suffix, and the ``.rpm`` suffix
+ will be added automatically.