diff options
| author | Alex Turbov <i.zaufi@gmail.com> | 2017-04-09 00:39:06 +0700 |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2017-04-11 10:17:00 -0400 |
| commit | 3b4848717aa23d0238e97fb7d381829e6e47f722 (patch) | |
| tree | e9a1bfeae99263a9335e2e8dffd04349b97b675a /Help/variable | |
| parent | c791fb12544926bc5870a61735dc2ec62940a6f6 (diff) | |
| download | cmake-3b4848717aa23d0238e97fb7d381829e6e47f722.tar.gz | |
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`.
Diffstat (limited to 'Help/variable')
| -rw-r--r-- | Help/variable/CMAKE_PROJECT_DESCRIPTION.rst | 7 | ||||
| -rw-r--r-- | Help/variable/PROJECT_DESCRIPTION.rst | 6 |
2 files changed, 13 insertions, 0 deletions
diff --git a/Help/variable/CMAKE_PROJECT_DESCRIPTION.rst b/Help/variable/CMAKE_PROJECT_DESCRIPTION.rst new file mode 100644 index 0000000000..f1911eced4 --- /dev/null +++ b/Help/variable/CMAKE_PROJECT_DESCRIPTION.rst @@ -0,0 +1,7 @@ +CMAKE_PROJECT_DESCRIPTION +------------------------- + +The description of the current project. + +This specifies description of the current project from the closest inherited +:command:`project` command. diff --git a/Help/variable/PROJECT_DESCRIPTION.rst b/Help/variable/PROJECT_DESCRIPTION.rst new file mode 100644 index 0000000000..05ede8fccd --- /dev/null +++ b/Help/variable/PROJECT_DESCRIPTION.rst @@ -0,0 +1,6 @@ +PROJECT_DESCRIPTION +------------------- + +Short project description given to the project command. + +This is the description given to the most recent :command:`project` command. |