Help: Minor grammar, typo and formatting cleanups

This commit is contained in:
Craig Scott
2022-10-08 20:10:41 +11:00
parent 3de30134f1
commit f8b3b24915
12 changed files with 21 additions and 19 deletions
+4 -3
View File
@@ -315,8 +315,9 @@ a build configuration.
the generated project (unless overridden by an explicit option). the generated project (unless overridden by an explicit option).
.. versionchanged:: 3.14 .. versionchanged:: 3.14
For the :generator:`Green Hills MULTI` generator the GHS toolset and target For the :generator:`Green Hills MULTI` generator, the GHS toolset and target
system customization cache variables are also propagated into the test project. system customization cache variables are also propagated into the test
project.
.. versionadded:: 3.24 .. versionadded:: 3.24
The :variable:`CMAKE_TRY_COMPILE_NO_PLATFORM_VARIABLES` variable may be The :variable:`CMAKE_TRY_COMPILE_NO_PLATFORM_VARIABLES` variable may be
@@ -324,5 +325,5 @@ a build configuration.
.. versionadded:: 3.25 .. versionadded:: 3.25
If :policy:`CMP0141` is set to ``NEW``, one can use 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. information format.
+1 -1
View File
@@ -278,7 +278,7 @@ Options
.. option:: --debug-trycompile .. 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. :command:`try_compile` / :command:`try_run` calls.
This is useful in debugging failed checks. This is useful in debugging failed checks.
+1 -1
View File
@@ -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 The ``OLD`` behavior for this policy is to ignore any parameters given to the
command. 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. This policy was introduced in CMake version 3.25.
CMake version |release| warns when the policy is not set and uses CMake version |release| warns when the policy is not set and uses
+1 -1
View File
@@ -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 format flags in the default :variable:`CMAKE_<LANG>_FLAGS_<CONFIG>` cache
entries and ignore the :variable:`CMAKE_MSVC_DEBUG_INFORMATION_FORMAT` entries and ignore the :variable:`CMAKE_MSVC_DEBUG_INFORMATION_FORMAT`
abstraction. The ``NEW`` behavior for this policy is to *not* place MSVC 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. the abstraction instead.
This policy was introduced in CMake version 3.25. Use the This policy was introduced in CMake version 3.25. Use the
+2 -1
View File
@@ -32,4 +32,5 @@ implemented :variable:`compiler IDs <CMAKE_<LANG>_COMPILER_ID>` are:
* ``XLClang`` * ``XLClang``
This property is initialized by the value of the variable 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.
@@ -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)` This property is normally only set by :command:`target_sources(FILE_SET)`
rather than being manipulated directly. rather than being manipulated directly.
See :prop_tgt:`CXX_MODULE_HEADER_UNIT_DIRS_<NAME>` for the list of base directories See :prop_tgt:`CXX_MODULE_HEADER_UNIT_DIRS_<NAME>` for the list of base
in other C++ module header sets. directories in other C++ module header sets.
+2 -2
View File
@@ -6,8 +6,8 @@ CXX_MODULE_SETS
Experimental. Gated by ``CMAKE_EXPERIMENTAL_CXX_MODULE_CMAKE_API`` Experimental. Gated by ``CMAKE_EXPERIMENTAL_CXX_MODULE_CMAKE_API``
Read-only list of the target's ``PRIVATE`` and ``PUBLIC`` C++ module sets (i.e. 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 all file sets with the type ``CXX_MODULES``). Files listed in these file sets
treated as source files for the purpose of IDE integration. are treated as source files for the purpose of IDE integration.
C++ module sets may be defined using the :command:`target_sources` command C++ module sets may be defined using the :command:`target_sources` command
``FILE_SET`` option with type ``CXX_MODULES``. ``FILE_SET`` option with type ``CXX_MODULES``.
+3 -3
View File
@@ -4,8 +4,8 @@ EXPORT_NO_SYSTEM
.. versionadded:: 3.25 .. versionadded:: 3.25
Specifies that :command:`install(EXPORT)` and :command:`export` commands will 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 See the :prop_tgt:`NO_SYSTEM_FROM_IMPORTED` target property to set this
behavior on the target consuming the include directories rather than behavior on the target *consuming* the include directories rather than the
providing them. one *providing* them.
+1 -1
View File
@@ -18,7 +18,7 @@ command line.
.. versionchanged:: 3.25 .. versionchanged:: 3.25
If the specified ``clang-tidy`` command line includes the ``-p`` option, 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 ``clang-tidy`` will look up the source file in the specified compiler
commands database. commands database.
@@ -8,8 +8,8 @@
Compile with ``-ZI`` or equivalent flag(s) to produce a program Compile with ``-ZI`` or equivalent flag(s) to produce a program
database that supports the Edit and Continue feature. 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. 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. information format flag will be added explicitly by CMake.
@@ -3,7 +3,7 @@ MSVC_DEBUG_INFORMATION_FORMAT
.. versionadded:: 3.25 .. versionadded:: 3.25
Select debug information format targeting the MSVC ABI. Select debug information format when targeting the MSVC ABI.
The allowed values are: The allowed values are:
+1 -1
View File
@@ -11,7 +11,7 @@ incompatible versioning schemes. Set this variable in a
the compiler and version correctly. If no toolset is specified, the compiler and version correctly. If no toolset is specified,
``Standalone`` is assumed. ``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 take :variable:`CMAKE_TASKING_TOOLSET` and
:variable:`CMAKE_<LANG>_COMPILER_ARCHITECTURE_ID` into account to qualify :variable:`CMAKE_<LANG>_COMPILER_ARCHITECTURE_ID` into account to qualify
:variable:`CMAKE_<LANG>_COMPILER_VERSION`. :variable:`CMAKE_<LANG>_COMPILER_VERSION`.