From 5000f93a91a5a9f0964d415692ffc05df0114eb1 Mon Sep 17 00:00:00 2001 From: Nikita Nemkin Date: Tue, 1 Dec 2020 22:58:21 +0500 Subject: Help: Fix grammar in `.. versionadded` directives Issue: #19715 --- Help/command/ctest_submit.rst | 10 +++++----- Help/command/file.rst | 2 +- Help/command/find_package.rst | 2 +- Help/command/get_filename_component.rst | 2 +- Help/command/list.rst | 4 ++-- Help/command/message.rst | 2 +- Help/command/project.rst | 7 ++++--- Help/command/string.rst | 4 ++-- Help/cpack_gen/deb.rst | 4 ++-- Help/cpack_gen/freebsd.rst | 2 +- Help/cpack_gen/rpm.rst | 6 +++--- Help/generator/Green Hills MULTI.rst | 2 +- 12 files changed, 24 insertions(+), 23 deletions(-) diff --git a/Help/command/ctest_submit.rst b/Help/command/ctest_submit.rst index 9c10318..e6d277f 100644 --- a/Help/command/ctest_submit.rst +++ b/Help/command/ctest_submit.rst @@ -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. diff --git a/Help/command/file.rst b/Help/command/file.rst index 9580c9c..6837672 100644 --- a/Help/command/file.rst +++ b/Help/command/file.rst @@ -126,7 +126,7 @@ Parse a list of ASCII strings from ```` 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 diff --git a/Help/command/find_package.rst b/Help/command/find_package.rst index 2ef3e97..3dfd62f 100644 --- a/Help/command/find_package.rst +++ b/Help/command/find_package.rst @@ -432,7 +432,7 @@ enabled. hard-coded guesses. .. versionadded:: 3.16 - Added ``CMAKE_FIND_USE__PATH`` variables to globally disable + Added the ``CMAKE_FIND_USE__PATH`` variables to globally disable various search locations. .. |FIND_XXX| replace:: find_package diff --git a/Help/command/get_filename_component.rst b/Help/command/get_filename_component.rst index e073a28..be9d00a 100644 --- a/Help/command/get_filename_component.rst +++ b/Help/command/get_filename_component.rst @@ -25,7 +25,7 @@ Sets ```` to a component of ````, where ```` 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 diff --git a/Help/command/list.rst b/Help/command/list.rst index ee3530c..7accc5a 100644 --- a/Help/command/list.rst +++ b/Help/command/list.rst @@ -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 ```` option should be one of: diff --git a/Help/command/message.rst b/Help/command/message.rst index 3ea82a6..e44803e 100644 --- a/Help/command/message.rst +++ b/Help/command/message.rst @@ -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 diff --git a/Help/command/project.rst b/Help/command/project.rst index 29c9ad4..6c931b6 100644 --- a/Help/command/project.rst +++ b/Help/command/project.rst @@ -76,7 +76,7 @@ The options are: then the description is also stored in the variable :variable:`CMAKE_PROJECT_DESCRIPTION`. .. versionadded:: 3.12 - Added ``_DESCRIPTION`` variable. + Added the ``_DESCRIPTION`` variable. ``HOMEPAGE_URL `` .. versionadded:: 3.12 @@ -134,10 +134,11 @@ If both are set, then :variable:`CMAKE_PROJECT_INCLUDE` will be included before :variable:`CMAKE_PROJECT__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__INCLUDE_BEFORE`` variable. + Added the ``CMAKE_PROJECT__INCLUDE_BEFORE`` variable. Usage ^^^^^ diff --git a/Help/command/string.rst b/Help/command/string.rst index 178d9d3..8ad0089 100644 --- a/Help/command/string.rst +++ b/Help/command/string.rst @@ -335,7 +335,7 @@ Comparison Compare the strings and store true or false in the ````. .. 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 ```` algorithm names are: Keccak SHA-3. .. versionadded:: 3.8 - Added ``SHA3`` hash algorithms. + Added the ``SHA3_*`` hash algorithms. Generation ^^^^^^^^^^ diff --git a/Help/cpack_gen/deb.rst b/Help/cpack_gen/deb.rst index 8fbefdb..7cae613 100644 --- a/Help/cpack_gen/deb.rst +++ b/Help/cpack_gen/deb.rst @@ -224,7 +224,7 @@ List of CPack DEB generator specific variables: Per-component ``CPACK_DEBIAN__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:: diff --git a/Help/cpack_gen/freebsd.rst b/Help/cpack_gen/freebsd.rst index 3cfa4a0..2c93569 100644 --- a/Help/cpack_gen/freebsd.rst +++ b/Help/cpack_gen/freebsd.rst @@ -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 diff --git a/Help/cpack_gen/rpm.rst b/Help/cpack_gen/rpm.rst index a8c3c5c..5260a1d 100644 --- a/Help/cpack_gen/rpm.rst +++ b/Help/cpack_gen/rpm.rst @@ -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__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__USER_FILELIST diff --git a/Help/generator/Green Hills MULTI.rst b/Help/generator/Green Hills MULTI.rst index c25c5f5..5d2b1cd 100644 --- a/Help/generator/Green Hills MULTI.rst +++ b/Help/generator/Green Hills MULTI.rst @@ -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`` -- cgit v0.12