diff options
author | Brad King <brad.king@kitware.com> | 2018-10-08 11:21:48 -0400 |
---|---|---|
committer | Brad King <brad.king@kitware.com> | 2018-10-08 11:21:48 -0400 |
commit | c2356d60d8b3bc709ed5e95f98864ff504685010 (patch) | |
tree | 536401c72a423a65ef24d84861ae2e99a7c77e05 /Help | |
parent | 981cdceca20bd6ca84dd7118cb038fb54c81197d (diff) | |
parent | f8a086a86bd3f9301f04e5ad64b75fe960eee99a (diff) | |
download | cmake-c2356d60d8b3bc709ed5e95f98864ff504685010.tar.gz |
Merge branch 'project-always-set-desc-url' into release-3.13
Merge-request: !2457
Diffstat (limited to 'Help')
-rw-r--r-- | Help/command/project.rst | 2 |
1 files changed, 2 insertions, 0 deletions
diff --git a/Help/command/project.rst b/Help/command/project.rst index c1de05786e..bd8b4ef5c4 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. |