CMake/Help/variable/CMAKE_PROJECT_DESCRIPTION.rst at b2242ea9641cd09d94aaf77a33345100cc3a3def - CMake - Gitea - ZeroTwo

mirror/CMake

mirror of https://github.com/Kitware/CMake.git synced 2026-01-06 05:40:54 -06:00

Files

Alex Turbov 3b4848717a project: Add DESCRIPTION parameter

It is quite often the project description has used in a real world software.
Examples include:

* part of a help screen of the application
* builtin resources (`*.rc` files, data for "About" dialog of a GUI app, & etc)
* most generators for CPack can use it
* it could be used by documentary software (Doxygen, Sphinx) which is usually
  integrated to CMake based projects via `add_custom_target()`

Now `project()` call learned an optional `DESCRIPTION` parameter with a
short string describing a project. Being specified, it would set the
`PROJECT_DESCRIPTION` variable which could be used in `configure_file()`
or whatever user wants.  Also `PROJECT_DESCRIPTION` is a default value
for `CPACK_PACKAGE_DESCRIPTION_SUMMARY`.

2017-04-11 10:17:00 -04:00

8 lines

199 B

ReStructuredText

Raw Blame History

 CMAKE_PROJECT_DESCRIPTION
 -------------------------
 The description of the current project.
 This specifies description of the current project from the closest inherited
 :command:`project` command.