浏览代码

CPack: Document `CPACK_PACKAGE_DESCRIPTION` variable

Alex Turbov 7 年之前
父节点
当前提交
5fc59ea7c8
共有 1 个文件被更改,包括 11 次插入3 次删除
  1. 11 3
      Modules/CPack.cmake

+ 11 - 3
Modules/CPack.cmake

@@ -110,11 +110,19 @@ installers.  The most commonly-used variables are:
  0.1.1 will be assumed, leading to ``CPACK_PACKAGE_VERSION_PATCH`` having a
  default value of 1.
 
+.. variable:: CPACK_PACKAGE_DESCRIPTION
+
+  A description of the project, used in places such as the introduction
+  screen of CPack-generated Windows installers.  If not set, the value of
+  this variable is populated from the file named by
+  ``CPACK_PACKAGE_DESCRIPTION_FILE``.
+
 .. variable:: CPACK_PACKAGE_DESCRIPTION_FILE
 
- A text file used to describe the project. Used, for example, the
- introduction screen of a CPack-generated Windows installer to describe
- the project.
+  A text file used to describe the project when
+  ``CPACK_PACKAGE_DESCRIPTION`` is not explicitly set.  The default
+  value for ``CPACK_PACKAGE_DESCRIPTION_FILE`` points to a built-in template
+  file ``Templates/CPack.GenericDescription.txt``.
 
 .. variable:: CPACK_PACKAGE_DESCRIPTION_SUMMARY