mirror/CMake
1
0
Fork 0
mirror of https://github.com/Kitware/CMake.git synced 2026-04-19 12:50:48 -05:00
Code Issues Packages Projects Releases Wiki Activity

Help: Tweak project DESCRIPTION documentation

Browse Source 
Replace the 'project-description-string' descriptor in the `project`,
`export` and `install` commands with 'description-string'. This is more
consistent, as none of the other descriptors include 'project-', and
it's arguably wrong in the context of `export`/`install`, as the
description applies to a package.
This commit is contained in:
Matthew Woehlke
2025-06-12 17:07:57 -04:00
parent f19c3b8be6
commit f0b419c473
3 changed files with 6 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
Help/command/export.rst
View File

@@ -141,7 +141,7 @@ Exporting Targets to the |CPS|
[VERSION_SCHEMA <string>]] [VERSION_SCHEMA <string>]]
[DEFAULT_TARGETS <target>...] [DEFAULT_TARGETS <target>...]
[DEFAULT_CONFIGURATIONS <config>...] [DEFAULT_CONFIGURATIONS <config>...]
[DESCRIPTION <project-description-string>] [DESCRIPTION <description-string>]
[HOMEPAGE_URL <url-string>]) [HOMEPAGE_URL <url-string>])
.. versionadded:: 4.1 .. versionadded:: 4.1

4
Help/command/install.rst
View File

@@ -1001,7 +1001,7 @@ Signatures
[VERSION_SCHEMA <string>]] [VERSION_SCHEMA <string>]]
[DEFAULT_TARGETS <target>...] [DEFAULT_TARGETS <target>...]
[DEFAULT_CONFIGURATIONS <config>...] [DEFAULT_CONFIGURATIONS <config>...]
[DESCRIPTION <project-description-string>] [DESCRIPTION <description-string>]
[HOMEPAGE_URL <url-string>] [HOMEPAGE_URL <url-string>]
[PERMISSIONS <permission>...] [PERMISSIONS <permission>...]
[CONFIGURATIONS <config>...] [CONFIGURATIONS <config>...]
@@ -1059,7 +1059,7 @@ Signatures
configurations exists. If not specified, CMake will fall back to the configurations exists. If not specified, CMake will fall back to the
package's available configurations in an unspecified order. package's available configurations in an unspecified order.
``DESCRIPTION <project-description-string>`` ``DESCRIPTION <description-string>``
.. versionadded:: 4.1 .. versionadded:: 4.1
An informational description of the project. It is recommended that this An informational description of the project. It is recommended that this

6
Help/command/project.rst
View File

@@ -12,7 +12,7 @@ Synopsis
project(<PROJECT-NAME> project(<PROJECT-NAME>
[VERSION <major>[.<minor>[.<patch>[.<tweak>]]]] [VERSION <major>[.<minor>[.<patch>[.<tweak>]]]]
[COMPAT_VERSION <major>[.<minor>[.<patch>[.<tweak>]]]] [COMPAT_VERSION <major>[.<minor>[.<patch>[.<tweak>]]]]
[DESCRIPTION <project-description-string>] [DESCRIPTION <description-string>]
[HOMEPAGE_URL <url-string>] [HOMEPAGE_URL <url-string>]
[LANGUAGES <language-name>...]) [LANGUAGES <language-name>...])
@@ -106,7 +106,7 @@ The options are:
``CMakeLists.txt``, then the compatibility version is also stored in the ``CMakeLists.txt``, then the compatibility version is also stored in the
variable :variable:`CMAKE_PROJECT_COMPAT_VERSION`. variable :variable:`CMAKE_PROJECT_COMPAT_VERSION`.
``DESCRIPTION <project-description-string>`` ``DESCRIPTION <description-string>``
.. versionadded:: 3.9 .. versionadded:: 3.9
Optional. Optional.
@@ -114,7 +114,7 @@ The options are:
* :variable:`PROJECT_DESCRIPTION`, :variable:`<PROJECT-NAME>_DESCRIPTION` * :variable:`PROJECT_DESCRIPTION`, :variable:`<PROJECT-NAME>_DESCRIPTION`
to ``<project-description-string>``. to ``<description-string>``.
It is recommended that this description is a relatively short string, It is recommended that this description is a relatively short string,
usually no more than a few words. usually no more than a few words.