mirror/CMake
1
0
Fork 0
mirror of https://github.com/Kitware/CMake.git synced 2026-01-07 14:20:06 -06:00
Code Issues Packages Projects Releases Wiki Activity

CPack: Document CPACK_PACKAGE_DESCRIPTION variable

Browse Source
This commit is contained in:
Alex Turbov
2018-05-07 22:58:13 +03:00
committed by Brad King
parent 3f354d65b4
commit 5fc59ea7c8
1 changed files with 11 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
Modules/CPack.cmake
View File

@@ -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