Help: Fix grammar in .. versionadded directives

Issue: #19715
This commit is contained in:
Nikita Nemkin
2020-12-01 22:58:21 +05:00
parent 8fea95319b
commit 5000f93a91
12 changed files with 24 additions and 23 deletions

View File

@@ -115,16 +115,16 @@ to tell CDash which handler to use to process the data.
This signature interprets options in the same way as the first one.
.. versionadded:: 3.8
Added ``RETRY_COUNT``, ``RETRY_DELAY``, ``QUIET`` options.
Added the ``RETRY_COUNT``, ``RETRY_DELAY``, ``QUIET`` options.
.. versionadded:: 3.9
Added ``HTTPHEADER`` option.
Added the ``HTTPHEADER`` option.
.. versionadded:: 3.13
Added ``RETURN_VALUE`` option.
Added the ``RETURN_VALUE`` option.
.. versionadded:: 3.14
Added ``SUBMIT_URL`` option.
Added the ``SUBMIT_URL`` option.
.. versionadded:: 3.15
Added ``BUILD_ID`` option.
Added the ``BUILD_ID`` option.

View File

@@ -126,7 +126,7 @@ Parse a list of ASCII strings from ``<filename>`` and store it in
the ``ENCODING`` option will be defaulted to respect the Byte Order Mark.
.. versionadded:: 3.2
Added ``UTF-16LE``, ``UTF-16BE``, ``UTF-32LE``, ``UTF-32BE`` encodings.
Added the ``UTF-16LE``, ``UTF-16BE``, ``UTF-32LE``, ``UTF-32BE`` encodings.
For example, the code

View File

@@ -432,7 +432,7 @@ enabled.
hard-coded guesses.
.. versionadded:: 3.16
Added ``CMAKE_FIND_USE_<CATEGORY>_PATH`` variables to globally disable
Added the ``CMAKE_FIND_USE_<CATEGORY>_PATH`` variables to globally disable
various search locations.
.. |FIND_XXX| replace:: find_package

View File

@@ -25,7 +25,7 @@ Sets ``<var>`` to a component of ``<FileName>``, where ``<mode>`` is one of:
PATH = Legacy alias for DIRECTORY (use for CMake <= 2.8.11)
.. versionadded:: 3.14
Added ``LAST_EXT`` and ``NAME_WLE`` modes.
Added the ``LAST_EXT`` and ``NAME_WLE`` modes.
Paths are returned with forward slashes and have no trailing slashes.
If the optional ``CACHE`` argument is specified, the result variable is

View File

@@ -318,10 +318,10 @@ Reverses the contents of the list in-place.
Sorts the list in-place alphabetically.
.. versionadded:: 3.13
Added ``COMPARE``, ``CASE``, and ``ORDER`` options.
Added the ``COMPARE``, ``CASE``, and ``ORDER`` options.
.. versionadded:: 3.18
Added ``COMPARE NATURAL`` option.
Added the ``COMPARE NATURAL`` option.
Use the ``COMPARE`` keyword to select the comparison method for sorting.
The ``<compare>`` option should be one of:

View File

@@ -72,7 +72,7 @@ influences the way the message is handled:
removed before releasing the project, packaging up the files, etc.
.. versionadded:: 3.15
Added ``NOTICE``, ``VERBOSE``, ``DEBUG``, and ``TRACE`` levels.
Added the ``NOTICE``, ``VERBOSE``, ``DEBUG``, and ``TRACE`` levels.
The CMake command-line tool displays ``STATUS`` to ``TRACE`` messages on stdout
with the message preceded by two hyphens and a space. All other message types

View File

@@ -76,7 +76,7 @@ The options are:
then the description is also stored in the variable :variable:`CMAKE_PROJECT_DESCRIPTION`.
.. versionadded:: 3.12
Added ``<PROJECT-NAME>_DESCRIPTION`` variable.
Added the ``<PROJECT-NAME>_DESCRIPTION`` variable.
``HOMEPAGE_URL <url-string>``
.. versionadded:: 3.12
@@ -134,10 +134,11 @@ If both are set, then :variable:`CMAKE_PROJECT_INCLUDE` will be included before
:variable:`CMAKE_PROJECT_<PROJECT-NAME>_INCLUDE`.
.. versionadded:: 3.15
Added ``CMAKE_PROJECT_INCLUDE`` and ``CMAKE_PROJECT_INCLUDE_BEFORE`` variables.
Added the ``CMAKE_PROJECT_INCLUDE`` and ``CMAKE_PROJECT_INCLUDE_BEFORE``
variables.
.. versionadded:: 3.17
Added ``CMAKE_PROJECT_<PROJECT-NAME>_INCLUDE_BEFORE`` variable.
Added the ``CMAKE_PROJECT_<PROJECT-NAME>_INCLUDE_BEFORE`` variable.
Usage
^^^^^

View File

@@ -335,7 +335,7 @@ Comparison
Compare the strings and store true or false in the ``<output_variable>``.
.. versionadded:: 3.7
Added ``LESS_EQUAL`` and ``GREATER_EQUAL`` options.
Added the ``LESS_EQUAL`` and ``GREATER_EQUAL`` options.
.. _`Supported Hash Algorithms`:
@@ -373,7 +373,7 @@ The supported ``<HASH>`` algorithm names are:
Keccak SHA-3.
.. versionadded:: 3.8
Added ``SHA3`` hash algorithms.
Added the ``SHA3_*`` hash algorithms.
Generation
^^^^^^^^^^

View File

@@ -224,7 +224,7 @@ List of CPack DEB generator specific variables:
Per-component ``CPACK_DEBIAN_<COMPONENT>_DESCRIPTION`` variables.
.. versionadded:: 3.16
``CPACK_PACKAGE_DESCRIPTION_FILE`` variable.
The ``CPACK_PACKAGE_DESCRIPTION_FILE`` variable.
.. _Debian Policy Manual: https://www.debian.org/doc/debian-policy/ch-controlfields.html#description
@@ -303,7 +303,7 @@ List of CPack DEB generator specific variables:
* Default : :variable:`CMAKE_PROJECT_HOMEPAGE_URL`
.. versionadded:: 3.12
``CMAKE_PROJECT_HOMEPAGE_URL`` variable.
The ``CMAKE_PROJECT_HOMEPAGE_URL`` variable.
.. note::

View File

@@ -90,7 +90,7 @@ the RPM information (e.g. package license).
for Debian packaging, so we may as well re-use it).
.. versionadded:: 3.12
``CMAKE_PROJECT_HOMEPAGE_URL`` variable.
The ``CMAKE_PROJECT_HOMEPAGE_URL`` variable.
.. variable:: CPACK_FREEBSD_PACKAGE_LICENSE

View File

@@ -210,7 +210,7 @@ List of CPack RPM generator specific variables:
* Default : :variable:`CMAKE_PROJECT_HOMEPAGE_URL`
.. versionadded:: 3.12
``CMAKE_PROJECT_HOMEPAGE_URL`` variable.
The ``CMAKE_PROJECT_HOMEPAGE_URL`` variable.
.. variable:: CPACK_RPM_PACKAGE_DESCRIPTION
CPACK_RPM_<component>_PACKAGE_DESCRIPTION
@@ -527,7 +527,7 @@ List of CPack RPM generator specific variables:
rpm -qp --scripts package.rpm
.. versionadded:: 3.18
``CPACK_RPM_PRE_TRANS_SCRIPT_FILE`` variable.
The ``CPACK_RPM_PRE_TRANS_SCRIPT_FILE`` variable.
.. variable:: CPACK_RPM_POST_INSTALL_SCRIPT_FILE
CPACK_RPM_POST_UNINSTALL_SCRIPT_FILE
@@ -551,7 +551,7 @@ List of CPack RPM generator specific variables:
rpm -qp --scripts package.rpm
.. versionadded:: 3.18
``CPACK_RPM_POST_TRANS_SCRIPT_FILE`` variable.
The ``CPACK_RPM_POST_TRANS_SCRIPT_FILE`` variable.
.. variable:: CPACK_RPM_USER_FILELIST
CPACK_RPM_<COMPONENT>_USER_FILELIST

View File

@@ -65,7 +65,7 @@ Cache variables that are used for toolset and target system customization:
| ``GHS_OS_DIR_OPTION`` default value is ``-os_dir``.
.. versionadded:: 3.15
``GHS_OS_DIR_OPTION`` variable.
The ``GHS_OS_DIR_OPTION`` variable.
* ``GHS_BSP_NAME``