diff options
| author | Brad King <brad.king@kitware.com> | 2018-10-08 15:26:16 (GMT) |
|---|---|---|
| committer | Kitware Robot <kwrobot@kitware.com> | 2018-10-08 15:26:21 (GMT) |
| commit | c3e27c25625142aa1f1de36c454f00ee44df8dbd (patch) | |
| tree | 324589a94e981dd7a0dd0ff0c49466375e695f9d /Help | |
| parent | c76e024a3dee8933ff5b213149c295e2925b4860 (diff) | |
| parent | f8a086a86bd3f9301f04e5ad64b75fe960eee99a (diff) | |
| download | CMake-c3e27c25625142aa1f1de36c454f00ee44df8dbd.zip CMake-c3e27c25625142aa1f1de36c454f00ee44df8dbd.tar.gz CMake-c3e27c25625142aa1f1de36c454f00ee44df8dbd.tar.bz2 | |
Merge topic 'project-always-set-desc-url'
f8a086a86b project(): Ensure DESCRIPTION and HOMEPAGE_URL variables are set
b27247c8df project(): Add tests verifying variables set by second project() call
Acked-by: Kitware Robot <kwrobot@kitware.com>
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 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. |