1
0
mirror of https://github.com/Kitware/CMake.git synced 2025-10-16 05:26:58 +08:00

Help: Fix typos and spelling in documentation

This commit is contained in:
Josef Angstenberger
2021-05-06 21:24:28 +02:00
parent 03b1140ddc
commit 7072d83772
24 changed files with 28 additions and 28 deletions

View File

@@ -190,7 +190,7 @@ For example, the code:
.. code-block:: cmake
cmake_language(DEFER CALL message "${deferred_message}")
cmake_language(DEFER ID_VAR id CALL message "Cancelled Message")
cmake_language(DEFER ID_VAR id CALL message "Canceled Message")
cmake_language(DEFER CANCEL_CALL ${id})
message("Immediate Message")
set(deferred_message "Deferred Message")
@@ -201,7 +201,7 @@ prints::
Deferred Message
The ``Cancelled Message`` is never printed because its command is
cancelled. The ``deferred_message`` variable reference is not evaluated
canceled. The ``deferred_message`` variable reference is not evaluated
until the call site, so it can be set after the deferred call is scheduled.
In order to evaluate variable references immediately when scheduling a

View File

@@ -724,7 +724,7 @@ executable from the installation tree using the imported target name
``mp_myexe`` as if the target were built in its own tree.
.. note::
This command supercedes the :command:`install_targets` command and
This command supersedes the :command:`install_targets` command and
the :prop_tgt:`PRE_INSTALL_SCRIPT` and :prop_tgt:`POST_INSTALL_SCRIPT`
target properties. It also replaces the ``FILES`` forms of the
:command:`install_files` and :command:`install_programs` commands.

View File

@@ -5,7 +5,7 @@ install_files
Use the :command:`install(FILES)` command instead.
This command has been superceded by the :command:`install` command. It is
This command has been superseded by the :command:`install` command. It is
provided for compatibility with older CMake code. The ``FILES`` form is
directly replaced by the ``FILES`` form of the :command:`install`
command. The regexp form can be expressed more clearly using the ``GLOB``

View File

@@ -5,7 +5,7 @@ install_programs
Use the :command:`install(PROGRAMS)` command instead.
This command has been superceded by the :command:`install` command. It is
This command has been superseded by the :command:`install` command. It is
provided for compatibility with older CMake code. The ``FILES`` form is
directly replaced by the ``PROGRAMS`` form of the :command:`install`
command. The regexp form can be expressed more clearly using the ``GLOB``

View File

@@ -5,7 +5,7 @@ install_targets
Use the :command:`install(TARGETS)` command instead.
This command has been superceded by the :command:`install` command. It is
This command has been superseded by the :command:`install` command. It is
provided for compatibility with older CMake code.
::

View File

@@ -289,7 +289,7 @@ List of CPack DEB generator specific variables:
* Default : "optional"
.. versionadded:: 3.5
Per-component ``CPACK_DEBIAN_<COMPONENT>_PACKAGE_PRIORITY`` varables.
Per-component ``CPACK_DEBIAN_<COMPONENT>_PACKAGE_PRIORITY`` variables.
See https://www.debian.org/doc/debian-policy/ch-archive.html#s-priorities

View File

@@ -51,7 +51,7 @@ on macOS:
.. versionadded:: 3.6
Default behaviour is to include a symlink to ``/Applications`` in the DMG.
Default behavior is to include a symlink to ``/Applications`` in the DMG.
Set this option to ``ON`` to avoid adding the symlink.
.. variable:: CPACK_DMG_SLA_DIR

View File

@@ -8,4 +8,4 @@
See the :variable:`CMAKE_GENERATOR_TOOLSET` variable for details.
.. versionadded:: 3.14
Added suport for ``host=x86`` option.
Added support for ``host=x86`` option.

View File

@@ -640,7 +640,7 @@ We can use the :command:`find_package` command:
:start-after: # find MathFunctions
:end-before: # create executable
Create an exectuable:
Create an executable:
.. literalinclude:: Downstream/CMakeLists.txt
:language: cmake

View File

@@ -77,7 +77,7 @@
:variable:`CMAKE_GENERATOR_PLATFORM` variable for details.
``--toolchain <path-to-file>``
Specify the cross compiling toolchain file, equivalant to setting
Specify the cross compiling toolchain file, equivalent to setting
:variable:`CMAKE_TOOLCHAIN_FILE` variable.
``--install-prefix <directory>``

View File

@@ -1437,7 +1437,7 @@ The members specific to ``toolchains`` objects are:
``language``
A JSON string specifying the toolchain language, like C or CXX. Language
names are the same as langauge names that can be passed to the
names are the same as language names that can be passed to the
:command:`project` command. Because CMake only supports a single toolchain
per language, this field can be used as a key.

View File

@@ -60,7 +60,7 @@ Policies Introduced by CMake 3.21
CMP0124: foreach() loop variables are only available in the loop scope. </policy/CMP0124>
CMP0123: ARMClang cpu/arch compile and link flags must be set explicitly. </policy/CMP0123>
CMP0122: UseSWIG use standard library name conventions for csharp language. </policy/CMP0122>
CMP0121: The list command detects invalid indicies. </policy/CMP0121>
CMP0121: The list command detects invalid indices. </policy/CMP0121>
Policies Introduced by CMake 3.20
=================================

View File

@@ -702,7 +702,7 @@ Available commands are:
``remove [-f] <file>...``
.. deprecated:: 3.17
Remove the file(s). The planned behaviour was that if any of the
Remove the file(s). The planned behavior was that if any of the
listed files already do not exist, the command returns a non-zero exit code,
but no message is logged. The ``-f`` option changes the behavior to return a
zero exit code (i.e. success) in such situations instead.

View File

@@ -8,7 +8,7 @@ CMP0110
:command:`add_test` can now (officially) create tests with whitespace and
other special characters in its name. Before CMake version 3.19 that was not
allowed, however, it was possible to work around this limitation by explicitly
putting escaped quotes arount the test's name in the ``add_test`` command.
putting escaped quotes around the test's name in the ``add_test`` command.
Although never officially supported several projects in the wild found and
implemented this workaround. However, the new change which officially allows

View File

@@ -3,16 +3,16 @@ CMP0121
.. versionadded:: 3.21
The :command:`list` command now detects invalid indicies.
The :command:`list` command now detects invalid indices.
Prior to CMake version 3.21, the :command:`list` command's ``GET``,
``INSERT``, ``SUBLIST``, and ``REMOVE_AT`` subcommands did not detect invalid
index arguments.
The ``OLD`` behavior of this policy is for invalid indicies to be treated as
The ``OLD`` behavior of this policy is for invalid indices to be treated as
their integer value (if any) at the start of the string. For example,
``2good4you`` is a ``2`` and ``not_an_integer`` is a ``0``. The ``NEW``
behavior is for invalid indicies to trigger an error.
behavior is for invalid indices to trigger an error.
This policy was introduced in CMake version 3.21. CMake version |release|
warns when the policy is not set and uses ``OLD`` behavior. Use the

View File

@@ -35,9 +35,9 @@ The concept of a fixture is different to that of a resource specified by
set of tests which share setup and cleanup requirements, whereas a resource
lock has the effect of ensuring a particular set of tests do not run in
parallel. Some situations may need both, such as setting up a database,
serialising test access to that database and deleting the database again at the
serializing test access to that database and deleting the database again at the
end. For such cases, tests would populate both ``FIXTURES_REQUIRED`` and
:prop_test:`RESOURCE_LOCK` to combine the two behaviours. Names used for
:prop_test:`RESOURCE_LOCK` to combine the two behaviors. Names used for
:prop_test:`RESOURCE_LOCK` have no relationship with names of fixtures, so note
that a resource lock does not imply a fixture and vice versa.

View File

@@ -9,4 +9,4 @@ If the target contains Swift source files, this specifies the directory in which
the modules will be placed. When this property is not set, the modules will be
placed in the build directory corresponding to the target's source directory.
If the variable :variable:`CMAKE_Swift_MODULE_DIRECTORY` is set when a target is
created its value is used to initialise this property.
created its value is used to initialize this property.

View File

@@ -50,6 +50,6 @@ be used to avoid that with code like the following:
return MY_UNITY_ID::i;
}
The pseudononymous namespace is used within a truly anonymous namespace.
The pseudonymous namespace is used within a truly anonymous namespace.
On many platforms, this maintains the invariant that the symbols within
do not get external linkage when performing a unity build.

View File

@@ -40,7 +40,7 @@ Languages
customize the Swift module name.
* The :prop_sf:`Swift_DIAGNOSTICS_FILE` source property was added to
indicate where to write the serialised Swift diagnostics.
indicate where to write the serialized Swift diagnostics.
The Swift support is experimental, not considered stable, and may change
in future releases of CMake.

View File

@@ -233,7 +233,7 @@ Deprecated and Removed Features
instead.
* The :module:`GetPrerequisites` module has been deprecated, as it has been
superceded by :command:`file(GET_RUNTIME_DEPENDENCIES)`.
superseded by :command:`file(GET_RUNTIME_DEPENDENCIES)`.
* The ``CPACK_INSTALL_SCRIPT`` variable has been deprecated in favor of the
new, more accurately named :variable:`CPACK_INSTALL_SCRIPTS` variable.

View File

@@ -170,7 +170,7 @@ CPack
is used for dependency auto detection.
* The :cpack_gen:`CPack DEB Generator` learned how to generate
``DEBIAN/shlibs`` contorl file when package contains shared libraries.
``DEBIAN/shlibs`` control file when package contains shared libraries.
* The :cpack_gen:`CPack DEB Generator` learned how to generate
``DEBIAN/postinst`` and ``DEBIAN/postrm`` files if the package installs

View File

@@ -8,7 +8,7 @@ Switch between strict and relaxed automoc mode.
By default, :prop_tgt:`AUTOMOC` behaves exactly as described in the
documentation of the :prop_tgt:`AUTOMOC` target property. When set to
``TRUE``, it accepts more input and tries to find the correct input file for
``moc`` even if it differs from the documented behaviour. In this mode it
``moc`` even if it differs from the documented behavior. In this mode it
e.g. also checks whether a header file is intended to be processed by moc
when a ``"foo.moc"`` file has been included.

View File

@@ -5,6 +5,6 @@ CMAKE_Swift_MODULE_DIRECTORY
Swift module output directory.
This variable is used to initialise the :prop_tgt:`Swift_MODULE_DIRECTORY`
This variable is used to initialize the :prop_tgt:`Swift_MODULE_DIRECTORY`
property on all the targets. See the target property for additional
information.

View File

@@ -3,6 +3,6 @@ EXECUTABLE_OUTPUT_PATH
Old executable location variable.
The target property :prop_tgt:`RUNTIME_OUTPUT_DIRECTORY` supercedes this
The target property :prop_tgt:`RUNTIME_OUTPUT_DIRECTORY` supersedes this
variable for a target if it is set. Executable targets are otherwise placed in
this directory.