diff options
| author | Brad King <brad.king@kitware.com> | 2017-04-13 12:14:17 (GMT) |
|---|---|---|
| committer | Kitware Robot <kwrobot@kitware.com> | 2017-04-13 12:14:23 (GMT) |
| commit | 2cb98329f1e1175fb24d7ea3daf969f1de8a2a21 (patch) | |
| tree | 51fb2d104c764ef4a3b871188151c4833ea105ec /Help/command | |
| parent | 26b5f7defe10edeaac763487a26ab9a101f2ed8f (diff) | |
| parent | 3b4848717aa23d0238e97fb7d381829e6e47f722 (diff) | |
| download | CMake-2cb98329f1e1175fb24d7ea3daf969f1de8a2a21.zip CMake-2cb98329f1e1175fb24d7ea3daf969f1de8a2a21.tar.gz CMake-2cb98329f1e1175fb24d7ea3daf969f1de8a2a21.tar.bz2 | |
Merge topic 'project-description'
3b484871 project: Add `DESCRIPTION` parameter
Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !679
Diffstat (limited to 'Help/command')
| -rw-r--r-- | Help/command/project.rst | 5 |
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 |