diff options
| author | Craig Scott <craig.scott@crascit.com> | 2018-03-15 20:18:42 (GMT) |
|---|---|---|
| committer | Craig Scott <craig.scott@crascit.com> | 2018-03-16 21:25:48 (GMT) |
| commit | fd28c382b44ee355099750419ecd46e0aa175de0 (patch) | |
| tree | a3fa7b4829927a539d226545a14dbb9d37800368 /Help | |
| parent | 9b57cb62ea7f1557694054b552cbeb39fb12788e (diff) | |
| download | CMake-fd28c382b44ee355099750419ecd46e0aa175de0.zip CMake-fd28c382b44ee355099750419ecd46e0aa175de0.tar.gz CMake-fd28c382b44ee355099750419ecd46e0aa175de0.tar.bz2 | |
project: Add <PROJECT-NAME>_DESCRIPTION
For consistency with the VERSION keyword, also define the
<PROJECT-NAME>_DESCRIPTION variable.
Diffstat (limited to 'Help')
| -rw-r--r-- | Help/command/project.rst | 7 | ||||
| -rw-r--r-- | Help/manual/cmake-variables.7.rst | 1 | ||||
| -rw-r--r-- | Help/variable/PROJECT-NAME_DESCRIPTION.rst | 5 |
3 files changed, 10 insertions, 3 deletions
diff --git a/Help/command/project.rst b/Help/command/project.rst index ac71d7a..062e9ea 100644 --- a/Help/command/project.rst +++ b/Help/command/project.rst @@ -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``, diff --git a/Help/manual/cmake-variables.7.rst b/Help/manual/cmake-variables.7.rst index 13a72df..2bf8c9c 100644 --- a/Help/manual/cmake-variables.7.rst +++ b/Help/manual/cmake-variables.7.rst @@ -97,6 +97,7 @@ Variables that Provide Information /variable/CMAKE_XCODE_GENERATE_SCHEME /variable/CMAKE_XCODE_PLATFORM_TOOLSET /variable/PROJECT-NAME_BINARY_DIR + /variable/PROJECT-NAME_DESCRIPTION /variable/PROJECT-NAME_SOURCE_DIR /variable/PROJECT-NAME_VERSION /variable/PROJECT-NAME_VERSION_MAJOR diff --git a/Help/variable/PROJECT-NAME_DESCRIPTION.rst b/Help/variable/PROJECT-NAME_DESCRIPTION.rst new file mode 100644 index 0000000..2b88b1a --- /dev/null +++ b/Help/variable/PROJECT-NAME_DESCRIPTION.rst @@ -0,0 +1,5 @@ +<PROJECT-NAME>_DESCRIPTION +-------------------------- + +Value given to the ``DESCRIPTION`` option of the most recent call to the +:command:`project` command with project name ``<PROJECT-NAME>``, if any. |