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

Help: Format allowed CPACK_{DEB,RPM}_FILE_NAME values as definition list

This provides a structured location for notes about each value.
This commit is contained in:
Brad King
2023-11-27 10:21:36 -05:00
parent 0cd2ada2d1
commit 907d4db558
2 changed files with 22 additions and 19 deletions

View File

@@ -69,28 +69,27 @@ 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. The ``.deb`` suffix is required.
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.
``<file-name>.ipk``
.. versionadded:: 3.10
.. note::
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

View File

@@ -84,9 +84,13 @@ 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. The ``.rpm`` suffix is required.
.. note::