summaryrefslogtreecommitdiffstats
path: root/Help/command
diff options
context:
space:
mode:
authorAlex Turbov <i.zaufi@gmail.com>2017-04-08 17:39:06 (GMT)
committerBrad King <brad.king@kitware.com>2017-04-11 14:17:00 (GMT)
commit3b4848717aa23d0238e97fb7d381829e6e47f722 (patch)
treee9a1bfeae99263a9335e2e8dffd04349b97b675a /Help/command
parentc791fb12544926bc5870a61735dc2ec62940a6f6 (diff)
downloadCMake-3b4848717aa23d0238e97fb7d381829e6e47f722.zip
CMake-3b4848717aa23d0238e97fb7d381829e6e47f722.tar.gz
CMake-3b4848717aa23d0238e97fb7d381829e6e47f722.tar.bz2
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/command')
-rw-r--r--Help/command/project.rst5
1 files changed, 5 insertions, 0 deletions
diff --git a/Help/command/project.rst b/Help/command/project.rst
index 6c5ace7..139f69c 100644
--- a/Help/command/project.rst
+++ b/Help/command/project.rst
@@ -8,6 +8,7 @@ Set a name, version, and enable languages for the entire project.
project(<PROJECT-NAME> [LANGUAGES] [<language-name>...])
project(<PROJECT-NAME>
[VERSION <major>[.<minor>[.<patch>[.<tweak>]]]]
+ [DESCRIPTION <project-description-string>]
[LANGUAGES <language-name>...])
Sets the name of the project and stores the name in the
@@ -40,6 +41,10 @@ in variables
Variables corresponding to unspecified versions are set to the empty string
(if policy :policy:`CMP0048` is set to ``NEW``).
+If optional ``DESCRIPTION`` is given, then additional :variable:`PROJECT_DESCRIPTION`
+variable will be set to its argument. The argument must be a string with short
+description of the project (only a few words).
+
Optionally you can specify which languages your project supports.
Example languages are ``C``, ``CXX`` (i.e. C++), ``Fortran``, etc.
By default ``C`` and ``CXX`` are enabled if no language options are