Browse Source

CPackDeb: CPACK_DEBIAN_PACKAGE_NAME documentation improvement

Domen Vrankar 10 years ago
parent
commit
57672e7275
1 changed files with 10 additions and 2 deletions
  1. 10 2
      Modules/CPackDeb.cmake

+ 10 - 2
Modules/CPackDeb.cmake

@@ -29,10 +29,18 @@
 # .. variable:: CPACK_DEBIAN_PACKAGE_NAME
 #               CPACK_DEBIAN_<COMPONENT>_PACKAGE_NAME
 #
-#  The Debian package summary
+#  Set Package control field (variable is automatically transformed to lower
+#  case).
 #
 #  * Mandatory : YES
-#  * Default   : :variable:`CPACK_PACKAGE_NAME` (lower case)
+#  * Default   :
+#
+#    - :variable:`CPACK_PACKAGE_NAME` for non-component based
+#      installations
+#    - :variable:`CPACK_DEBIAN_PACKAGE_NAME` suffixed with -<COMPONENT>
+#      for component-based installations.
+#
+#  See https://www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-Source
 #
 #
 # .. variable:: CPACK_DEBIAN_PACKAGE_VERSION