summaryrefslogtreecommitdiff
path: root/Help
diff options
context:
space:
mode:
authorCraig Scott <craig.scott@crascit.com>2022-10-08 20:10:41 +1100
committerCraig Scott <craig.scott@crascit.com>2022-10-09 13:34:05 +1100
commitf8b3b24915163ab4de94c13bdeb7a314597fb030 (patch)
tree75ebf03dfd1aff7818db9c842c0f1110a84e2a40 /Help
parent3de30134f1432e877bbf133bcb18797c09801209 (diff)
downloadcmake-f8b3b24915163ab4de94c13bdeb7a314597fb030.tar.gz
Help: Minor grammar, typo and formatting cleanups
Diffstat (limited to 'Help')
-rw-r--r--Help/command/try_compile.rst7
-rw-r--r--Help/manual/cmake.1.rst2
-rw-r--r--Help/policy/CMP0140.rst2
-rw-r--r--Help/policy/CMP0141.rst2
-rw-r--r--Help/prop_tgt/COMPILE_WARNING_AS_ERROR.rst3
-rw-r--r--Help/prop_tgt/CXX_MODULE_HEADER_UNIT_DIRS.rst4
-rw-r--r--Help/prop_tgt/CXX_MODULE_SETS.rst4
-rw-r--r--Help/prop_tgt/EXPORT_NO_SYSTEM.rst6
-rw-r--r--Help/prop_tgt/LANG_CLANG_TIDY.rst2
-rw-r--r--Help/prop_tgt/MSVC_DEBUG_INFORMATION_FORMAT-VALUES.txt4
-rw-r--r--Help/prop_tgt/MSVC_DEBUG_INFORMATION_FORMAT.rst2
-rw-r--r--Help/variable/CMAKE_TASKING_TOOLSET.rst2
12 files changed, 21 insertions, 19 deletions
diff --git a/Help/command/try_compile.rst b/Help/command/try_compile.rst
index b5fad773e7..3a6b26a035 100644
--- a/Help/command/try_compile.rst
+++ b/Help/command/try_compile.rst
@@ -315,8 +315,9 @@ a build configuration.
the generated project (unless overridden by an explicit option).
.. versionchanged:: 3.14
- For the :generator:`Green Hills MULTI` generator the GHS toolset and target
- system customization cache variables are also propagated into the test project.
+ For the :generator:`Green Hills MULTI` generator, the GHS toolset and target
+ system customization cache variables are also propagated into the test
+ project.
.. versionadded:: 3.24
The :variable:`CMAKE_TRY_COMPILE_NO_PLATFORM_VARIABLES` variable may be
@@ -324,5 +325,5 @@ a build configuration.
.. versionadded:: 3.25
If :policy:`CMP0141` is set to ``NEW``, one can use
- :variable:`CMAKE_MSVC_DEBUG_INFORMATION_FORMAT` to specify MSVC debug
+ :variable:`CMAKE_MSVC_DEBUG_INFORMATION_FORMAT` to specify the MSVC debug
information format.
diff --git a/Help/manual/cmake.1.rst b/Help/manual/cmake.1.rst
index 879ad0b6ea..9384524327 100644
--- a/Help/manual/cmake.1.rst
+++ b/Help/manual/cmake.1.rst
@@ -278,7 +278,7 @@ Options
.. option:: --debug-trycompile
- Do not delete the the files and directories created for
+ Do not delete the files and directories created for
:command:`try_compile` / :command:`try_run` calls.
This is useful in debugging failed checks.
diff --git a/Help/policy/CMP0140.rst b/Help/policy/CMP0140.rst
index 2e2d0c3511..dea8989e1f 100644
--- a/Help/policy/CMP0140.rst
+++ b/Help/policy/CMP0140.rst
@@ -7,7 +7,7 @@ The :command:`return` command checks its parameters.
The ``OLD`` behavior for this policy is to ignore any parameters given to the
command.
-The ``NEW`` behavior is to check validity of the parameters.
+The ``NEW`` behavior is to check the validity of the parameters.
This policy was introduced in CMake version 3.25.
CMake version |release| warns when the policy is not set and uses
diff --git a/Help/policy/CMP0141.rst b/Help/policy/CMP0141.rst
index 51fa5fd533..970e41db2a 100644
--- a/Help/policy/CMP0141.rst
+++ b/Help/policy/CMP0141.rst
@@ -44,7 +44,7 @@ The ``OLD`` behavior for this policy is to place MSVC debug information
format flags in the default :variable:`CMAKE_<LANG>_FLAGS_<CONFIG>` cache
entries and ignore the :variable:`CMAKE_MSVC_DEBUG_INFORMATION_FORMAT`
abstraction. The ``NEW`` behavior for this policy is to *not* place MSVC
-debug information format flags flags in the default cache entries and use
+debug information format flags in the default cache entries and use
the abstraction instead.
This policy was introduced in CMake version 3.25. Use the
diff --git a/Help/prop_tgt/COMPILE_WARNING_AS_ERROR.rst b/Help/prop_tgt/COMPILE_WARNING_AS_ERROR.rst
index 684b9ddb46..32ed6d0c60 100644
--- a/Help/prop_tgt/COMPILE_WARNING_AS_ERROR.rst
+++ b/Help/prop_tgt/COMPILE_WARNING_AS_ERROR.rst
@@ -32,4 +32,5 @@ implemented :variable:`compiler IDs <CMAKE_<LANG>_COMPILER_ID>` are:
* ``XLClang``
This property is initialized by the value of the variable
-:variable:`CMAKE_COMPILE_WARNING_AS_ERROR` if it is set when a target is created.
+:variable:`CMAKE_COMPILE_WARNING_AS_ERROR` if it is set when a target is
+created.
diff --git a/Help/prop_tgt/CXX_MODULE_HEADER_UNIT_DIRS.rst b/Help/prop_tgt/CXX_MODULE_HEADER_UNIT_DIRS.rst
index 17e5cf0ed7..d5aa2ab887 100644
--- a/Help/prop_tgt/CXX_MODULE_HEADER_UNIT_DIRS.rst
+++ b/Help/prop_tgt/CXX_MODULE_HEADER_UNIT_DIRS.rst
@@ -13,5 +13,5 @@ module header set (i.e. the file set with name and type
This property is normally only set by :command:`target_sources(FILE_SET)`
rather than being manipulated directly.
-See :prop_tgt:`CXX_MODULE_HEADER_UNIT_DIRS_<NAME>` for the list of base directories
-in other C++ module header sets.
+See :prop_tgt:`CXX_MODULE_HEADER_UNIT_DIRS_<NAME>` for the list of base
+directories in other C++ module header sets.
diff --git a/Help/prop_tgt/CXX_MODULE_SETS.rst b/Help/prop_tgt/CXX_MODULE_SETS.rst
index c03df391ac..c0532783d9 100644
--- a/Help/prop_tgt/CXX_MODULE_SETS.rst
+++ b/Help/prop_tgt/CXX_MODULE_SETS.rst
@@ -6,8 +6,8 @@ CXX_MODULE_SETS
Experimental. Gated by ``CMAKE_EXPERIMENTAL_CXX_MODULE_CMAKE_API``
Read-only list of the target's ``PRIVATE`` and ``PUBLIC`` C++ module sets (i.e.
-all file sets with the type ``CXX_MODULES``). Files listed in these file sets are
-treated as source files for the purpose of IDE integration.
+all file sets with the type ``CXX_MODULES``). Files listed in these file sets
+are treated as source files for the purpose of IDE integration.
C++ module sets may be defined using the :command:`target_sources` command
``FILE_SET`` option with type ``CXX_MODULES``.
diff --git a/Help/prop_tgt/EXPORT_NO_SYSTEM.rst b/Help/prop_tgt/EXPORT_NO_SYSTEM.rst
index c93d1a55fe..61f0a8da14 100644
--- a/Help/prop_tgt/EXPORT_NO_SYSTEM.rst
+++ b/Help/prop_tgt/EXPORT_NO_SYSTEM.rst
@@ -4,8 +4,8 @@ EXPORT_NO_SYSTEM
.. versionadded:: 3.25
Specifies that :command:`install(EXPORT)` and :command:`export` commands will
-generate a imported target with :prop_tgt:`SYSTEM` property `OFF`.
+generate an imported target with :prop_tgt:`SYSTEM` property `OFF`.
See the :prop_tgt:`NO_SYSTEM_FROM_IMPORTED` target property to set this
-behavior on the target consuming the include directories rather than
-providing them.
+behavior on the target *consuming* the include directories rather than the
+one *providing* them.
diff --git a/Help/prop_tgt/LANG_CLANG_TIDY.rst b/Help/prop_tgt/LANG_CLANG_TIDY.rst
index ffa0b9a205..31f1876e3b 100644
--- a/Help/prop_tgt/LANG_CLANG_TIDY.rst
+++ b/Help/prop_tgt/LANG_CLANG_TIDY.rst
@@ -18,7 +18,7 @@ command line.
.. versionchanged:: 3.25
If the specified ``clang-tidy`` command line includes the ``-p`` option,
- it will invoked without ``--`` and the full compiler command line.
+ it will be invoked without ``--`` and the full compiler command line.
``clang-tidy`` will look up the source file in the specified compiler
commands database.
diff --git a/Help/prop_tgt/MSVC_DEBUG_INFORMATION_FORMAT-VALUES.txt b/Help/prop_tgt/MSVC_DEBUG_INFORMATION_FORMAT-VALUES.txt
index 9a6846004b..889d97a418 100644
--- a/Help/prop_tgt/MSVC_DEBUG_INFORMATION_FORMAT-VALUES.txt
+++ b/Help/prop_tgt/MSVC_DEBUG_INFORMATION_FORMAT-VALUES.txt
@@ -8,8 +8,8 @@
Compile with ``-ZI`` or equivalent flag(s) to produce a program
database that supports the Edit and Continue feature.
-The value is ignored on non-MSVC compilers but an unsupported value will
+The value is ignored on non-MSVC compilers, but an unsupported value will
be rejected as an error when using a compiler targeting the MSVC ABI.
-The value may also be the empty string (``""``) in which case no debug
+The value may also be the empty string (``""``), in which case no debug
information format flag will be added explicitly by CMake.
diff --git a/Help/prop_tgt/MSVC_DEBUG_INFORMATION_FORMAT.rst b/Help/prop_tgt/MSVC_DEBUG_INFORMATION_FORMAT.rst
index 2314cffb21..0c7845ce4a 100644
--- a/Help/prop_tgt/MSVC_DEBUG_INFORMATION_FORMAT.rst
+++ b/Help/prop_tgt/MSVC_DEBUG_INFORMATION_FORMAT.rst
@@ -3,7 +3,7 @@ MSVC_DEBUG_INFORMATION_FORMAT
.. versionadded:: 3.25
-Select debug information format targeting the MSVC ABI.
+Select debug information format when targeting the MSVC ABI.
The allowed values are:
diff --git a/Help/variable/CMAKE_TASKING_TOOLSET.rst b/Help/variable/CMAKE_TASKING_TOOLSET.rst
index 430207ebca..940606b816 100644
--- a/Help/variable/CMAKE_TASKING_TOOLSET.rst
+++ b/Help/variable/CMAKE_TASKING_TOOLSET.rst
@@ -11,7 +11,7 @@ incompatible versioning schemes. Set this variable in a
the compiler and version correctly. If no toolset is specified,
``Standalone`` is assumed.
-Projects, that can be build with different architectures and/or toolsets, must
+Projects that can be built with different architectures and/or toolsets must
take :variable:`CMAKE_TASKING_TOOLSET` and
:variable:`CMAKE_<LANG>_COMPILER_ARCHITECTURE_ID` into account to qualify
:variable:`CMAKE_<LANG>_COMPILER_VERSION`.