summaryrefslogtreecommitdiffstats
path: root/Help
diff options
context:
space:
mode:
authorCraig Scott <craig.scott@crascit.com>2018-10-07 21:18:50 (GMT)
committerCraig Scott <craig.scott@crascit.com>2018-10-07 21:28:17 (GMT)
commitf8a086a86bd3f9301f04e5ad64b75fe960eee99a (patch)
treeada2aceb55ee583d2ccb1f0c9b88526d593cb3f9 /Help
parentb27247c8df5c88193304149269ab0dbb0e8c35e4 (diff)
downloadCMake-f8a086a86bd3f9301f04e5ad64b75fe960eee99a.zip
CMake-f8a086a86bd3f9301f04e5ad64b75fe960eee99a.tar.gz
CMake-f8a086a86bd3f9301f04e5ad64b75fe960eee99a.tar.bz2
project(): Ensure DESCRIPTION and HOMEPAGE_URL variables are set
If a project() call does not have DESCRIPTION or HOMEPAGE_URL options, it must still set the relevant variables or else those variables will inherit values from an earlier project() call. That is inconsistent with how VERSION is handled and is likely to be unexpected. The docs were also ambiguous about what should happen in such cases.
Diffstat (limited to 'Help')
-rw-r--r--Help/command/project.rst2
1 files changed, 2 insertions, 0 deletions
diff --git a/Help/command/project.rst b/Help/command/project.rst
index c1de057..bd8b4ef 100644
--- a/Help/command/project.rst
+++ b/Help/command/project.rst
@@ -44,6 +44,7 @@ Variables corresponding to unspecified versions are set to the empty string
If the optional ``DESCRIPTION`` is given, then :variable:`PROJECT_DESCRIPTION`
and :variable:`<PROJECT-NAME>_DESCRIPTION` will be set to its argument.
+These variables will be cleared if ``DESCRIPTION`` is not given.
The description is expected to be a relatively short string, usually no more
than a few words.
@@ -51,6 +52,7 @@ The optional ``HOMEPAGE_URL`` sets the analogous variables
:variable:`PROJECT_HOMEPAGE_URL` and :variable:`<PROJECT-NAME>_HOMEPAGE_URL`.
When this option is given, the URL provided should be the canonical home for
the project.
+These variables will be cleared if ``HOMEPAGE_URL`` is not given.
Note that the description and homepage URL may be used as defaults for
things like packaging meta-data, documentation, etc.