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/variable/PROJECT_NAME.rst | |
| 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/variable/PROJECT_NAME.rst')
| -rw-r--r-- | Help/variable/PROJECT_NAME.rst | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/Help/variable/PROJECT_NAME.rst b/Help/variable/PROJECT_NAME.rst index 61aa8bc..672680a 100644 --- a/Help/variable/PROJECT_NAME.rst +++ b/Help/variable/PROJECT_NAME.rst @@ -3,4 +3,6 @@ PROJECT_NAME Name of the project given to the project command. -This is the name given to the most recent :command:`project` command. +This is the name given to the most recently called :command:`project` +command in the current directory scope or above. To obtain the name of +the top level project, see the :variable:`CMAKE_PROJECT_NAME` variable. |