project: Add <PROJECT-NAME>_DESCRIPTION

For consistency with the VERSION keyword, also define the
<PROJECT-NAME>_DESCRIPTION variable.
This commit is contained in:
Craig Scott
2018-03-16 07:18:42 +11:00
parent 9b57cb62ea
commit fd28c382b4
4 changed files with 12 additions and 3 deletions

View File

@@ -41,9 +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).
If the optional ``DESCRIPTION`` is given, then :variable:`PROJECT_DESCRIPTION`
and :variable:`<PROJECT-NAME>_DESCRIPTION` will be set to its argument.
The description is expected to be a relatively short string, usually no more
than a few words.
Optionally you can specify which languages your project supports.
Example languages include ``C``, ``CXX`` (i.e. C++), ``CUDA``,