diff options
| author | Craig Scott <craig.scott@crascit.com> | 2018-03-13 11:30:36 (GMT) |
|---|---|---|
| committer | Craig Scott <craig.scott@crascit.com> | 2018-03-13 20:33:38 (GMT) |
| commit | 6a2a9d107dfeb86187459c224805128ee332f8eb (patch) | |
| tree | 3c221629dfafe04855adc80020ee66630eb9422f /Help/command | |
| parent | b2584ce069eae0d4b5a1cccf19295e5fde4c1082 (diff) | |
| download | CMake-6a2a9d107dfeb86187459c224805128ee332f8eb.zip CMake-6a2a9d107dfeb86187459c224805128ee332f8eb.tar.gz CMake-6a2a9d107dfeb86187459c224805128ee332f8eb.tar.bz2 | |
Help: Fix incorrect CMAKE_PROJECT_xxx docs
The docs for CMAKE_PROJECT_NAME and CMAKE_PROJECT_DESCRIPTION
were erroneously documenting the behavior of PROJECT_NAME and
PROJECT_DESCRIPTION respectively. Fix these and update the
project() docs to also mention CMAKE_PROJECT_NAME and
CMAKE_PROJECT_DESCRIPTION.
Fixes: #17815
Diffstat (limited to 'Help/command')
| -rw-r--r-- | Help/command/project.rst | 7 |
1 files changed, 5 insertions, 2 deletions
diff --git a/Help/command/project.rst b/Help/command/project.rst index eb185e4..ac71d7a 100644 --- a/Help/command/project.rst +++ b/Help/command/project.rst @@ -1,7 +1,7 @@ project ------- -Set a name, version, and enable languages for the entire project. +Sets project details such as name, version, etc. and enables languages. .. code-block:: cmake @@ -63,7 +63,10 @@ The top-level ``CMakeLists.txt`` file for a project must contain a literal, direct call to the :command:`project` command; loading one through the :command:`include` command is not sufficient. If no such call exists CMake will implicitly add one to the top that enables the -default languages (``C`` and ``CXX``). +default languages (``C`` and ``CXX``). The name of the project set in +the top level CMakeLists.txt file is available from the +:variable:`CMAKE_PROJECT_NAME` variable and its description from +:variable:`CMAKE_PROJECT_DESCRIPTION`. .. note:: Call the :command:`cmake_minimum_required` command at the beginning |