From 907d4db558aceab9cf8f834d536e48d5c42f9108 Mon Sep 17 00:00:00 2001 From: Brad King Date: Mon, 27 Nov 2023 10:21:36 -0500 Subject: Help: Format allowed CPACK_{DEB,RPM}_FILE_NAME values as definition list This provides a structured location for notes about each value. --- Help/cpack_gen/deb.rst | 31 +++++++++++++++---------------- Help/cpack_gen/rpm.rst | 10 +++++++--- 2 files changed, 22 insertions(+), 19 deletions(-) diff --git a/Help/cpack_gen/deb.rst b/Help/cpack_gen/deb.rst index 705ec9c..1aac279 100644 --- a/Help/cpack_gen/deb.rst +++ b/Help/cpack_gen/deb.rst @@ -69,28 +69,27 @@ List of CPack DEB generator specific variables: :Mandatory: Yes :Default: ``[-].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: - _-_.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. + _-_.deb - .. versionadded:: 3.10 - ``.ipk`` suffix used by OPKG packaging system. - - .. note:: + 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. - 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. + ``.deb`` + Use the given file name. The ``.deb`` suffix is required. - .. note:: + ``.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..ebdb721 100644 --- a/Help/cpack_gen/rpm.rst +++ b/Help/cpack_gen/rpm.rst @@ -84,9 +84,13 @@ List of CPack RPM generator specific variables: :Default: ``[-].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. + + ``.rpm`` + Use the given file name. The ``.rpm`` suffix is required. .. note:: -- cgit v0.12