diff options
| author | Alex Turbov <i.zaufi@gmail.com> | 2018-05-07 19:58:13 (GMT) |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2018-05-08 18:00:00 (GMT) |
| commit | 5fc59ea7c844854b0ea620002934c9f818b9d9b5 (patch) | |
| tree | f4054f0a0368d68e7c9f2801f27c5919f2153a23 /Modules | |
| parent | 3f354d65b4f2b329ac785e44170bbbfa1cb3e885 (diff) | |
| download | CMake-5fc59ea7c844854b0ea620002934c9f818b9d9b5.zip CMake-5fc59ea7c844854b0ea620002934c9f818b9d9b5.tar.gz CMake-5fc59ea7c844854b0ea620002934c9f818b9d9b5.tar.bz2 | |
CPack: Document `CPACK_PACKAGE_DESCRIPTION` variable
Diffstat (limited to 'Modules')
| -rw-r--r-- | Modules/CPack.cmake | 14 |
1 files changed, 11 insertions, 3 deletions
diff --git a/Modules/CPack.cmake b/Modules/CPack.cmake index 309d31c..a0f95f3 100644 --- a/Modules/CPack.cmake +++ b/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 |