summaryrefslogtreecommitdiffstats
path: root/Help
diff options
context:
space:
mode:
authorKyle Edwards <kyle.edwards@kitware.com>2019-09-26 13:22:18 (GMT)
committerKitware Robot <kwrobot@kitware.com>2019-09-26 13:23:31 (GMT)
commit5fa625d611414ac567fd7a6bb5b3b416ea93eca2 (patch)
tree10e0e3548bf22a486ec39e87e1acbe44f60b988a /Help
parent67e6b55c5885c445b5b78b41a66529553dcab069 (diff)
parent33c7ea513dc8a7e1322c5c37003c7c515bd8ad99 (diff)
downloadCMake-5fa625d611414ac567fd7a6bb5b3b416ea93eca2.zip
CMake-5fa625d611414ac567fd7a6bb5b3b416ea93eca2.tar.gz
CMake-5fa625d611414ac567fd7a6bb5b3b416ea93eca2.tar.bz2
Merge topic 'cpack-DEB-use-CPACK_PACKAGE_DESCRIPTION_FILE'
33c7ea513d CPackDeb: Use `CPACK_PACKAGE_DESCRIPTION_FILE` 53be31e19c Refactor: Use `list` commands instead of old-way string ops b2c67a7703 Style: Remove spaces after command call and `(` Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !3541
Diffstat (limited to 'Help')
-rw-r--r--Help/cpack_gen/deb.rst14
1 files changed, 11 insertions, 3 deletions
diff --git a/Help/cpack_gen/deb.rst b/Help/cpack_gen/deb.rst
index 23f0515..db71c87 100644
--- a/Help/cpack_gen/deb.rst
+++ b/Help/cpack_gen/deb.rst
@@ -179,16 +179,24 @@ List of CPack DEB generator specific variables:
* Default : ``CPACK_PACKAGE_CONTACT``
.. variable:: CPACK_DEBIAN_PACKAGE_DESCRIPTION
- CPACK_COMPONENT_<COMPONENT>_DESCRIPTION
+ CPACK_DEBIAN_<COMPONENT>_DESCRIPTION
The Debian package description
* Mandatory : YES
* Default :
- - :variable:`CPACK_DEBIAN_PACKAGE_DESCRIPTION` if set or
- - :variable:`CPACK_PACKAGE_DESCRIPTION_SUMMARY`
+ - :variable:`CPACK_DEBIAN_<COMPONENT>_DESCRIPTION` (component
+ based installers only) if set, or :variable:`CPACK_DEBIAN_PACKAGE_DESCRIPTION` if set, or
+ - :variable:`CPACK_COMPONENT_<compName>_DESCRIPTION` (component
+ based installers only) if set, or :variable:`CPACK_PACKAGE_DESCRIPTION` if set, or
+ - content of the file specified in :variable:`CPACK_PACKAGE_DESCRIPTION_FILE` if set
+ If after that description is not set, :variable:`CPACK_PACKAGE_DESCRIPTION_SUMMARY` going to be
+ used if set. Otherwise, :variable:`CPACK_PACKAGE_DESCRIPTION_SUMMARY` will be added as the first
+ line of description as defined in `Debian Policy Manual`_.
+
+.. _Debian Policy Manual: https://www.debian.org/doc/debian-policy/ch-controlfields.html#description
.. variable:: CPACK_DEBIAN_PACKAGE_SECTION
CPACK_DEBIAN_<COMPONENT>_PACKAGE_SECTION