Skip to content

Commit 7d63306

Browse files
[clang] Fix typos in documentation (#140211)
1 parent 5c60f06 commit 7d63306

11 files changed

+22
-22
lines changed

clang/docs/DebuggingCoroutines.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -255,7 +255,7 @@ However, when optimizations are enabled, the printed result changes drastically:
255255
{__resume_fn = 0x401280 <coro_task(int)>, __destroy_fn = 0x401390 <coro_task(int)>, __promise = {count = 1}, __int_32_0 = 43, __coro_index = 1 '\001'}
256256
257257
Unused values are optimized out, as well as the name of the local variable `a`.
258-
The only information remained is the value of a 32 bit integer. In this simple
258+
The only information remained is the value of a 32-bit integer. In this simple
259259
case, it seems to be pretty clear that `__int_32_0` represents `a`. However, it
260260
is not true.
261261

clang/docs/InternalsManual.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -3560,7 +3560,7 @@ For example:
35603560

35613561
// expected-note {{{evaluates to '{{2, 3, 4}} == {0, 3, 4}'}}}
35623562

3563-
The intent is to allow the delimeter to be wider than the longest `{` or `}`
3563+
The intent is to allow the delimiter to be wider than the longest `{` or `}`
35643564
brace sequence in the content, so that if your expected text contains `{{{`
35653565
(three braces) it may be delimited with `{{{{` (four braces), and so on.
35663566

clang/docs/LanguageExtensions.rst

+4-4
Original file line numberDiff line numberDiff line change
@@ -497,7 +497,7 @@ __const, __const__, __volatile, __volatile__, __restrict, __restrict__
497497
----------------------------------------------------------------------
498498

499499
These are alternate spellings for their non-underscore counterparts, but are
500-
available in all langauge modes.
500+
available in all language modes.
501501

502502
__decltype
503503
----------
@@ -526,7 +526,7 @@ __typeof, __typeof__, __typeof_unqual, __typeof_unqual__
526526
--------------------------------------------------------
527527

528528
``__typeof`` and ``__typeof__`` are alternate spellings for ``typeof``, but are
529-
available in all langauge modes. These spellings result in the operand,
529+
available in all language modes. These spellings result in the operand,
530530
retaining all qualifiers.
531531

532532
``__typeof_unqual`` and ``__typeof_unqual__`` are alternate spellings for the
@@ -2043,7 +2043,7 @@ references can be used instead of numeric references.
20432043
}
20442044

20452045

2046-
Constexpr strings in GNU ASM statememts
2046+
Constexpr strings in GNU ASM statements
20472047
=======================================
20482048

20492049
In C++11 mode (and greater), Clang supports specifying the template,
@@ -4412,7 +4412,7 @@ It is undefined behavior to call this function on an already initialized
44124412
A builtin function for the target-specific ``va_start`` function-like macro,
44134413
available only in C23 and later. The builtin accepts zero or one argument for
44144414
the ellipsis (``...``). If such an argument is provided, it should be the name
4415-
of the parameter preceeding the ellipsis, which is used for compatibility with
4415+
of the parameter preceding the ellipsis, which is used for compatibility with
44164416
C versions before C23. It is an error to provide two or more variadic arguments.
44174417
This function initializes the given ``__builtin_va_list`` object. It is
44184418
undefined behavior to call this function on an already initialized

clang/docs/Modules.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -613,10 +613,10 @@ tls
613613
A specific target feature (e.g., ``sse4``, ``avx``, ``neon``) is available.
614614

615615
*platform/os*
616-
A os/platform variant (e.g. ``freebsd``, ``win32``, ``windows``, ``linux``, ``ios``, ``macos``, ``iossimulator``) is available.
616+
An os/platform variant (e.g. ``freebsd``, ``win32``, ``windows``, ``linux``, ``ios``, ``macos``, ``iossimulator``) is available.
617617

618618
*environment*
619-
A environment variant (e.g. ``gnu``, ``gnueabi``, ``android``, ``msvc``) is available.
619+
An environment variant (e.g. ``gnu``, ``gnueabi``, ``android``, ``msvc``) is available.
620620

621621
**Example:** The ``std`` module can be extended to also include C++ and C++11 headers using a *requires-declaration*:
622622

clang/docs/PointerAuthentication.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -554,7 +554,7 @@ with this idea:
554554

555555
- It's unclear whether this kind of encryption is even possible without
556556
increasing the storage size of a signed pointer. If the storage size can be
557-
increased, brute-force atacks can be equally well mitigated by simply storing
557+
increased, brute-force attacks can be equally well mitigated by simply storing
558558
a larger signature.
559559

560560
- It would likely be impossible to implement a ``strip`` operation, which might

clang/docs/RealtimeSanitizer.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,7 @@ A **partial** list of flags RealtimeSanitizer respects:
187187
* - ``abort_on_error``
188188
- OS dependent
189189
- boolean
190-
- If true, the tool calls ``abort()`` instead of ``_exit()`` after printing the error report. On some OSes (MacOS, for exmple) this is beneficial because a better stack trace is emitted on crash.
190+
- If true, the tool calls ``abort()`` instead of ``_exit()`` after printing the error report. On some OSes (MacOS, for example) this is beneficial because a better stack trace is emitted on crash.
191191
* - ``symbolize``
192192
- ``true``
193193
- boolean
@@ -279,7 +279,7 @@ In general, ``ScopedDisabler`` should be preferred, as it is the most performant
279279
- Run-time
280280
- Stack
281281
- High
282-
- Suppresses any stack trace contaning the specified pattern.
282+
- Suppresses any stack trace containing the specified pattern.
283283

284284

285285
``ScopedDisabler``

clang/docs/ReleaseNotes.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -487,7 +487,7 @@ Improvements to Clang's diagnostics
487487
488488
- An error is now emitted when a ``musttail`` call is made to a function marked with the ``not_tail_called`` attribute. (#GH133509).
489489

490-
- ``-Whigher-precisision-for-complex-divison`` warns when:
490+
- ``-Whigher-precision-for-complex-divison`` warns when:
491491

492492
- The divisor is complex.
493493
- When the complex division happens in a higher precision type due to arithmetic promotion.
@@ -627,7 +627,7 @@ Bug Fixes in This Version
627627
Bug Fixes to Compiler Builtins
628628
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
629629

630-
- The behvaiour of ``__add_pointer`` and ``__remove_pointer`` for Objective-C++'s ``id`` and interfaces has been fixed.
630+
- The behaviour of ``__add_pointer`` and ``__remove_pointer`` for Objective-C++'s ``id`` and interfaces has been fixed.
631631

632632
- The signature for ``__builtin___clear_cache`` was changed from
633633
``void(char *, char *)`` to ``void(void *, void *)`` to match GCC's signature
@@ -702,7 +702,7 @@ Bug Fixes to C++ Support
702702
not in the last position.
703703
- Disallow overloading on struct vs class on dependent types, which is IFNDR, as
704704
this makes the problem diagnosable.
705-
- Improved preservation of the presence or abscence of typename specifier when
705+
- Improved preservation of the presence or absence of typename specifier when
706706
printing types in diagnostics.
707707
- Clang now correctly parses ``if constexpr`` expressions in immediate function context. (#GH123524)
708708
- Fixed an assertion failure affecting code that uses C++23 "deducing this". (#GH130272)

clang/docs/StandardCPlusPlusModules.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -709,7 +709,7 @@ Before Clang 19, a change in BMI of any (transitive) dependency would cause the
709709
outputs of the BMI to change. Starting with Clang 19, changes to non-direct
710710
dependencies should not directly affect the output BMI, unless they affect the
711711
results of the compilations. We expect that there are many more opportunities
712-
for this optimization than we currently have realized and would appreaciate
712+
for this optimization than we currently have realized and would appreciate
713713
feedback about missed optimization opportunities. For example,
714714

715715
.. code-block:: c++

clang/docs/UsersManual.rst

+4-4
Original file line numberDiff line numberDiff line change
@@ -921,7 +921,7 @@ Clang options that don't fit neatly into other categories.
921921

922922
Instruct clang not to emit the signature string for blocks. Disabling the
923923
string can potentially break existing code that relies on it. Users should
924-
carefully consider this possibiilty when using the flag.
924+
carefully consider this possibility when using the flag.
925925

926926
.. _configuration-files:
927927

@@ -3198,7 +3198,7 @@ indexed format, regardeless whether it is produced by frontend or the IR pass.
31983198
.. option:: -fprofile-continuous
31993199

32003200
Enables the continuous instrumentation profiling where profile counter updates
3201-
are continuously synced to a file. This option sets any neccessary modifiers
3201+
are continuously synced to a file. This option sets any necessary modifiers
32023202
(currently ``%c``) in the default profile filename and passes any necessary
32033203
flags to the middle-end to support this mode. Value profiling is not supported
32043204
in continuous mode.
@@ -3327,7 +3327,7 @@ on the ``-fprofile-generate`` and the ``-fprofile-use`` flags.
33273327
* ``__LLVM_INSTR_PROFILE_USE``: defined when one of
33283328
``-fprofile-use``/``-fprofile-instr-use`` is in effect.
33293329

3330-
The two macros can be used to provide more flexibiilty so a user program
3330+
The two macros can be used to provide more flexibility so a user program
33313331
can execute code specifically intended for profile generate or profile use.
33323332
For example, a user program can have special logging during profile generate:
33333333

@@ -4154,7 +4154,7 @@ There is a set of concrete HW architectures that OpenCL can be compiled for.
41544154
Generic Targets
41554155
^^^^^^^^^^^^^^^
41564156

4157-
- A SPIR-V binary can be produced for 32 or 64 bit targets.
4157+
- A SPIR-V binary can be produced for 32- or 64-bit targets.
41584158

41594159
.. code-block:: console
41604160

clang/docs/analyzer/checkers.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -1460,7 +1460,7 @@ overflow occurs), the checker assumes that the the index (more precisely, the
14601460
memory offeset) is within bounds.
14611461
14621462
However, if :ref:`optin-taint-GenericTaint` is enabled and the index/offset is
1463-
tainted (i.e. it is influenced by an untrusted souce), then this checker
1463+
tainted (i.e. it is influenced by an untrusted source), then this checker
14641464
reports the potential out of bounds access:
14651465
14661466
.. code-block:: c
@@ -2710,7 +2710,7 @@ Check for proper uses of CFNumber APIs.
27102710
27112711
CFNumberRef test(unsigned char x) {
27122712
return CFNumberCreate(0, kCFNumberSInt16Type, &x);
2713-
// warn: 8 bit integer is used to initialize a 16 bit integer
2713+
// warn: 8-bit integer is used to initialize a 16-bit integer
27142714
}
27152715
27162716
.. _osx-coreFoundation-CFRetainRelease:

clang/docs/analyzer/user-docs/Installation.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Packaged builds for other platforms may eventually be provided, but we need volu
2828
[Legacy] Using Packaged Builds
2929
------------------------------
3030

31-
To use the legacy pacakge builds, simply unpack it anywhere. If the build archive has the name **``checker-XXX.tar.bz2``** then the archive will expand to a directory called **``checker-XXX``**. You do not need to place this directory or the contents of this directory in any special place. Uninstalling the analyzer is as simple as deleting this directory.
31+
To use the legacy package builds, simply unpack it anywhere. If the build archive has the name **``checker-XXX.tar.bz2``** then the archive will expand to a directory called **``checker-XXX``**. You do not need to place this directory or the contents of this directory in any special place. Uninstalling the analyzer is as simple as deleting this directory.
3232

3333
Most of the files in the **``checker-XXX``** directory will be supporting files for the analyzer that you can simply ignore. Most users will only care about two files, which are located at the top of the **``checker-XXX``** directory:
3434

0 commit comments

Comments
 (0)