Skip to content

Commit 2db0812

Browse files
[clang] Fix typos in documentation
1 parent d9377c1 commit 2db0812

9 files changed

+27
-27
lines changed

clang/docs/AutomaticReferenceCounting.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1306,7 +1306,7 @@ or between ARC and non-ARC modes) under the following conditions:
13061306

13071307
- The types must be compatible ignoring ownership qualifiers according
13081308
to the baseline, non-ARC rules (e.g. C struct compatibility or C++'s
1309-
ODR). This condition implies a pairwise correspondance between
1309+
ODR). This condition implies a pairwise correspondence between
13101310
fields.
13111311

13121312
Note that an Objective-C++ class with base classes, a user-provided
@@ -1351,7 +1351,7 @@ automatically by the compiler.
13511351
.. admonition:: Rationale
13521352

13531353
In earlier releases, when non-trivial ownership was only permitted
1354-
on fields in Objective-C++, the ABI used for such classees was the
1354+
on fields in Objective-C++, the ABI used for such classes was the
13551355
ordinary ABI for non-trivial C++ classes, which passes arguments and
13561356
returns indirectly and does not transfer responsibility for arguments.
13571357
When support for Objective-C structs was added, it was decided to

clang/docs/ClangFormatStyleOptions.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2453,7 +2453,7 @@ the configuration (without a prefix: ``Auto``).
24532453
* ``BBCDS_Allowed`` (in configuration: ``Allowed``)
24542454
Breaking between template declaration and ``concept`` is allowed. The
24552455
actual behavior depends on the content and line breaking rules and
2456-
penalities.
2456+
penalties.
24572457

24582458
* ``BBCDS_Always`` (in configuration: ``Always``)
24592459
Always break before ``concept``, putting it in the line after the

clang/docs/DataFlowSanitizer.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,7 @@ For example:
140140
For instrumented functions, the ABI list supports a ``force_zero_labels``
141141
category, which will make all stores and return values set zero labels.
142142
Functions should never be labelled with both ``force_zero_labels``
143-
and ``uninstrumented`` or any of the unistrumented wrapper kinds.
143+
and ``uninstrumented`` or any of the uninstrumented wrapper kinds.
144144

145145
For example:
146146

clang/docs/LanguageExtensions.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2613,7 +2613,7 @@ In the format string, a suitable format specifier will be used for builtin
26132613
types that Clang knows how to format. This includes standard builtin types, as
26142614
well as aggregate structures, ``void*`` (printed with ``%p``), and ``const
26152615
char*`` (printed with ``%s``). A ``*%p`` specifier will be used for a field
2616-
that Clang doesn't know how to format, and the corresopnding argument will be a
2616+
that Clang doesn't know how to format, and the corresponding argument will be a
26172617
pointer to the field. This allows a C++ templated formatting function to detect
26182618
this case and implement custom formatting. A ``*`` will otherwise not precede a
26192619
format specifier.
@@ -2963,7 +2963,7 @@ data into the cache before it gets used.
29632963
**Description**:
29642964
29652965
The ``__builtin_prefetch(addr, rw, locality)`` builtin is expected to be used to
2966-
avoid cache misses when the developper has a good understanding of which data
2966+
avoid cache misses when the developer has a good understanding of which data
29672967
are going to be used next. ``addr`` is the address that needs to be brought into
29682968
the cache. ``rw`` indicates the expected access mode: ``0`` for *read* and ``1``
29692969
for *write*. In case of *read write* access, ``1`` is to be used. ``locality``
@@ -3432,7 +3432,7 @@ longer usable unless re-initialized with a call to ``__builtin_va_start`` or
34323432
34333433
A builtin function for the target-specific ``va_arg`` function-like macro. This
34343434
function returns the value of the next variadic argument to the call. It is
3435-
undefined behavior to call this builtin when there is no next varadic argument
3435+
undefined behavior to call this builtin when there is no next variadic argument
34363436
to retrieve or if the next variadic argument does not have a type compatible
34373437
with the given ``type-name``. The return type of the function is the
34383438
``type-name`` given as the second argument. It is undefined behavior to call

clang/docs/ReleaseNotes.rst

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ C++23 Feature Support
106106
Explicitly defaulted functions no longer have to be constexpr-compatible but merely constexpr suitable.
107107
We do not support outside of defaulted special memeber functions the change that constexpr functions no
108108
longer have to be constexpr compatible but rather support a less restricted requirements for constexpr
109-
functions. Which include allowing non-literal types as return values and paremeters, allow calling of
109+
functions. Which include allowing non-literal types as return values and parameters, allow calling of
110110
non-constexpr functions and constructors.
111111

112112
Resolutions to C++ Defect Reports
@@ -181,7 +181,7 @@ Non-comprehensive list of changes in this release
181181
- Clang now supports expressions in ``#pragma clang __debug dump``.
182182
- Clang now supports declaration of multi-dimensional arrays with
183183
``__declspec(property)``.
184-
- A new builtin type trait ``__is_trivially_equaltiy_comparable`` has been added,
184+
- A new builtin type trait ``__is_trivially_equality_comparable`` has been added,
185185
which checks whether comparing two instances of a type is equivalent to
186186
``memcmp(&lhs, &rhs, sizeof(T)) == 0``.
187187
- Clang now ignores null directives outside of the include guard when deciding
@@ -253,7 +253,7 @@ Improvements to Clang's diagnostics
253253
- Clang now avoids duplicate warnings on unreachable ``[[fallthrough]];`` statements
254254
previously issued from ``-Wunreachable-code`` and ``-Wunreachable-code-fallthrough``
255255
by prioritizing ``-Wunreachable-code-fallthrough``.
256-
- Clang now correctly diagnoses statement attributes ``[[clang::always_inine]]`` and
256+
- Clang now correctly diagnoses statement attributes ``[[clang::always_inline]]`` and
257257
``[[clang::noinline]]`` when used on a statement with dependent call expressions.
258258
- Clang now checks for completeness of the second and third arguments in the
259259
conditional operator.
@@ -315,12 +315,12 @@ Bug Fixes in This Version
315315
- Fix crash when using ``[[clang::always_inline]]`` or ``[[clang::noinline]]``
316316
statement attributes on a call to a template function in the body of a
317317
template function.
318-
- Fix coroutines issue where ``get_return_object()`` result was always eargerly
318+
- Fix coroutines issue where ``get_return_object()`` result was always eagerly
319319
converted to the return type. Eager initialization (allowing RVO) is now only
320-
perfomed when these types match, otherwise deferred initialization is used,
320+
performed when these types match, otherwise deferred initialization is used,
321321
enabling short-circuiting coroutines use cases. This fixes
322322
(`#56532 <https://github.com/llvm/llvm-project/issues/56532>`_) in
323-
antecipation of `CWG2563 <https://cplusplus.github.io/CWG/issues/2563.html>_`.
323+
anticipation of `CWG2563 <https://cplusplus.github.io/CWG/issues/2563.html>_`.
324324
- Fix highlighting issue with ``_Complex`` and initialization list with more than
325325
2 items. (`#61518 <https://github.com/llvm/llvm-project/issues/61518>`_)
326326
- Fix ``getSourceRange`` on ``VarTemplateSpecializationDecl`` and
@@ -421,7 +421,7 @@ Bug Fixes to C++ Support
421421
- Fix incorrect deletion of the default constructor of unions in some
422422
cases. (`#48416 <https://github.com/llvm/llvm-project/issues/48416>`_)
423423
- No longer issue a pre-C++23 compatibility warning in ``-pedantic`` mode
424-
regading overloaded `operator[]` with more than one parmeter or for static
424+
regarding overloaded `operator[]` with more than one parameter or for static
425425
lambdas. (`#61582 <https://github.com/llvm/llvm-project/issues/61582>`_)
426426
- Stop stripping CV qualifiers from the type of ``this`` when capturing it by value in
427427
a lambda.
@@ -602,7 +602,7 @@ libclang
602602

603603
- Added check in ``clang_getFieldDeclBitWidth`` for whether a bit-field
604604
has an evaluable bit width. Fixes undefined behavior when called on a
605-
bit-field whose width depends on a template paramter.
605+
bit-field whose width depends on a template parameter.
606606

607607
Static Analyzer
608608
---------------

clang/docs/StandardCPlusPlusModules.rst

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ Built Module Interface file
105105
~~~~~~~~~~~~~~~~~~~~~~~~~~~
106106

107107
A ``Built Module Interface file`` stands for the precompiled result of an importable module unit.
108-
It is also called the acronym ``BMI`` genrally.
108+
It is also called the acronym ``BMI`` generally.
109109

110110
Global module fragment
111111
~~~~~~~~~~~~~~~~~~~~~~
@@ -331,7 +331,7 @@ How to specify the dependent BMIs
331331

332332
There are 3 methods to specify the dependent BMIs:
333333

334-
* (1) ``-fprebuilt-module-path=<path/to/direcotry>``.
334+
* (1) ``-fprebuilt-module-path=<path/to/directory>``.
335335
* (2) ``-fmodule-file=<path/to/BMI>`` (Deprecated).
336336
* (3) ``-fmodule-file=<module-name>=<path/to/BMI>``.
337337

@@ -351,7 +351,7 @@ for the module specified by ``<module-name>`` when necessary. The main differenc
351351
with ``-fprebuilt-module-path``. The option ``-fmodule-file=<path/to/BMI>`` for named modules is deprecated
352352
and is planning to be removed in future versions.
353353

354-
In case all ``-fprebuilt-module-path=<path/to/direcotry>``, ``-fmodule-file=<path/to/BMI>`` and
354+
In case all ``-fprebuilt-module-path=<path/to/directory>``, ``-fmodule-file=<path/to/BMI>`` and
355355
``-fmodule-file=<module-name>=<path/to/BMI>`` exist, the ``-fmodule-file=<path/to/BMI>`` option
356356
takes highest precedence and ``-fmodule-file=<module-name>=<path/to/BMI>`` will take the second
357357
highest precedence.
@@ -366,7 +366,7 @@ the primary module interface unit.
366366
A module-declaration that contains neither an export-keyword nor a module-partition implicitly
367367
imports the primary module interface unit of the module as if by a module-import-declaration.
368368

369-
All of the 3 options ``-fprebuilt-module-path=<path/to/direcotry>``, ``-fmodule-file=<path/to/BMI>``
369+
All of the 3 options ``-fprebuilt-module-path=<path/to/directory>``, ``-fmodule-file=<path/to/BMI>``
370370
and ``-fmodule-file=<module-name>=<path/to/BMI>`` may occur multiple times.
371371
For example, the command line to compile ``M.cppm`` in
372372
the above example could be rewritten into:
@@ -791,7 +791,7 @@ Discover Dependencies
791791
=====================
792792

793793
Prior to modules, all the translation units can be compiled parallelly.
794-
But it is not true for the module units. The presense of module units requires
794+
But it is not true for the module units. The presence of module units requires
795795
us to compile the translation units in a (topological) order.
796796

797797
The clang-scan-deps scanner implemented
@@ -1011,10 +1011,10 @@ Then clang-scan-deps will extract the necessary information from the options.
10111011
Note that we need to specify the path to the compiler executable instead of saying
10121012
``clang++`` simply.
10131013

1014-
The users may want the scanner to get the tranditional dependency information for headers.
1014+
The users may want the scanner to get the transitional dependency information for headers.
10151015
Otherwise, the users have to scan twice for the project, once for headers and once for modules.
10161016
To address the requirement, clang-scan-deps will recognize the specified preprocessor options
1017-
in the given command line and generate the corresponding dependency informaiton. For example,
1017+
in the given command line and generate the corresponding dependency information. For example,
10181018

10191019
.. code-block:: console
10201020
@@ -1034,7 +1034,7 @@ We will get:
10341034
...
10351035
10361036
When clang-scan-deps detects ``-MF`` option, clang-scan-deps will try to write the
1037-
dependency informaiton for headers to the file specified by ``-MF``.
1037+
dependency information for headers to the file specified by ``-MF``.
10381038

10391039
Possible Questions
10401040
==================

clang/docs/UsersManual.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -810,7 +810,7 @@ compilations steps.
810810
811811
The report file specified in the option is locked for write, so this option
812812
can be used to collect statistics in parallel builds. The report file is not
813-
cleared, new data is appended to it, thus making posible to accumulate build
813+
cleared, new data is appended to it, thus making possible to accumulate build
814814
statistics.
815815

816816
You can also use environment variables to control the process statistics reporting.
@@ -3954,7 +3954,7 @@ mapping of default visibility to an explicit shared object export
39543954
* ``-mdefault-visibility-export-mapping=none``: no additional export
39553955
information is created for entities with default visibility.
39563956
* ``-mdefault-visibility-export-mapping=explicit``: mark entities for export
3957-
if they have explict (e.g. via an attribute) default visibility from the
3957+
if they have explicit (e.g. via an attribute) default visibility from the
39583958
source, including RTTI.
39593959
* ``-mdefault-visibility-export-mapping=all``: set XCOFF exported visibility
39603960
for all entities with default visibility from any source. This gives a

clang/docs/analyzer/checkers.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2317,7 +2317,7 @@ Corresponds to SEI CERT Rules ENV31-C and ENV34-C.
23172317
23182318
ENV31-C:
23192319
Rule is about the possible problem with `main` function's third argument, environment pointer,
2320-
"envp". When enviornment array is modified using some modification function
2320+
"envp". When environment array is modified using some modification function
23212321
such as putenv, setenv or others, It may happen that memory is reallocated,
23222322
however "envp" is not updated to reflect the changes and points to old memory
23232323
region.

clang/www/cxx_status.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1480,7 +1480,7 @@ <h2 id="cxx23">C++23 implementation status</h2>
14801480
<details><summary>Clang 17 (Partial)</summary>
14811481
We do not support outside of defaulted special memeber functions the change that constexpr functions no
14821482
longer have to be constexpr compatible but rather support a less restricted requirements for constexpr
1483-
functions. Which include allowing non-literal types as return values and paremeters, allow calling of
1483+
functions. Which include allowing non-literal types as return values and parameters, allow calling of
14841484
non-constexpr functions and constructors.
14851485
</details></td>
14861486
</td>

0 commit comments

Comments
 (0)