Skip to content

Commit 9f4cea2

Browse files
[llvm] Fix typos in documentation (#140844)
1 parent fe6290e commit 9f4cea2

12 files changed

+25
-25
lines changed

llvm/docs/AMDGPUUsage.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1222,7 +1222,7 @@ The AMDGPU backend implements the following LLVM IR intrinsics.
12221222
argument should be wavefront-uniform; the global pointer need not be.
12231223
The LDS pointer is implicitly offset by 4 * lane_id bytes for sies <= 4 bytes
12241224
and 16 * lane_id bytes for larger sizes. This lowers to `global_load_lds`,
1225-
`buffer_load_* ... lds`, or `global_load__* ... lds` depnedening on address
1225+
`buffer_load_* ... lds`, or `global_load__* ... lds` depending on address
12261226
space and architecture. `amdgcn.global.load.lds` has the same semantics as
12271227
`amdgcn.load.to.lds.p1`.
12281228
llvm.amdgcn.readfirstlane Provides direct access to v_readfirstlane_b32. Returns the value in
@@ -1354,7 +1354,7 @@ The AMDGPU backend implements the following LLVM IR intrinsics.
13541354
- 0x0020: VMEM read instructions may be scheduled across sched_barrier.
13551355
- 0x0040: VMEM write instructions may be scheduled across sched_barrier.
13561356
- 0x0080: All DS instructions may be scheduled across sched_barrier.
1357-
- 0x0100: All DS read instructions may be scheduled accoss sched_barrier.
1357+
- 0x0100: All DS read instructions may be scheduled across sched_barrier.
13581358
- 0x0200: All DS write instructions may be scheduled across sched_barrier.
13591359
- 0x0400: All Transcendental (e.g. V_EXP) instructions may be scheduled across sched_barrier.
13601360

@@ -1383,7 +1383,7 @@ The AMDGPU backend implements the following LLVM IR intrinsics.
13831383
| ``__builtin_amdgcn_sched_group_barrier(8, 5, 0)``
13841384

13851385
llvm.amdgcn.iglp.opt An **experimental** intrinsic for instruction group level parallelism. The intrinsic
1386-
implements predefined intruction scheduling orderings. The intrinsic applies to the
1386+
implements predefined instruction scheduling orderings. The intrinsic applies to the
13871387
surrounding scheduling region. The intrinsic takes a value that specifies the
13881388
strategy. The compiler implements two strategies.
13891389

llvm/docs/CMake.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -733,7 +733,7 @@ enabled sub-projects. Nearly all of these variable names begin with
733733
On Windows, allows embedding a different C runtime allocator into the LLVM
734734
tools and libraries. Using a lock-free allocator such as the ones listed below
735735
greatly decreases ThinLTO link time by about an order of magnitude. It also
736-
midly improves Clang build times, by about 5-10%. At the moment, rpmalloc,
736+
mildly improves Clang build times, by about 5-10%. At the moment, rpmalloc,
737737
snmalloc and mimalloc are supported. Use the path to `git clone` to select
738738
the respective allocator, for example:
739739

llvm/docs/ConvergenceAndUniformity.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ parallel environment. To eliminate this assumption:
4040
instruction can be examined for uniformity across multiple threads only if the
4141
corresponding executions of that instruction are converged.
4242

43-
This document decribes a static analysis for determining convergence at each
43+
This document describes a static analysis for determining convergence at each
4444
instruction in a function. The analysis extends previous work on divergence
4545
analysis [DivergenceSPMD]_ to cover irreducible control-flow. The described
4646
analysis is used in LLVM to implement a UniformityAnalysis that determines the

llvm/docs/LangRef.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3413,11 +3413,11 @@ memory before the call, the call may capture two components of the pointer:
34133413
whether only the fact that the address is/isn't null is captured.
34143414
* The provenance of the pointer, which is the ability to perform memory
34153415
accesses through the pointer, in the sense of the :ref:`pointer aliasing
3416-
rules <pointeraliasing>`. We further distinguish whether only read acceses
3416+
rules <pointeraliasing>`. We further distinguish whether only read accesses
34173417
are allowed, or both reads and writes.
34183418

34193419
For example, the following function captures the address of ``%a``, because
3420-
it is compared to a pointer, leaking information about the identitiy of the
3420+
it is compared to a pointer, leaking information about the identity of the
34213421
pointer:
34223422

34233423
.. code-block:: llvm
@@ -3472,7 +3472,7 @@ through the return value only:
34723472
However, we always consider direct inspection of the pointer address
34733473
(e.g. using ``ptrtoint``) to be location-independent. The following example
34743474
is *not* considered a return-only capture, even though the ``ptrtoint``
3475-
ultimately only contribues to the return value:
3475+
ultimately only contributes to the return value:
34763476

34773477
.. code-block:: llvm
34783478

@@ -17041,12 +17041,12 @@ and IEEE-754-2008: the result of ``minnum(-0.0, +0.0)`` may be either -0.0 or +0
1704117041

1704217042
Some architectures, such as ARMv8 (FMINNM), LoongArch (fmin), MIPSr6 (min.fmt), PowerPC/VSX (xsmindp),
1704317043
have instructions that match these semantics exactly; thus it is quite simple for these architectures.
17044-
Some architectures have similiar ones while they are not exact equivalent. Such as x86 implements ``MINPS``,
17044+
Some architectures have similar ones while they are not exact equivalent. Such as x86 implements ``MINPS``,
1704517045
which implements the semantics of C code ``a<b?a:b``: NUM vs qNaN always return qNaN. ``MINPS`` can be used
1704617046
if ``nsz`` and ``nnan`` are given.
1704717047

1704817048
For existing libc implementations, the behaviors of fmin may be quite different on sNaN and signed zero behaviors,
17049-
even in the same release of a single libm implemention.
17049+
even in the same release of a single libm implementation.
1705017050

1705117051
.. _i_maxnum:
1705217052

@@ -17101,12 +17101,12 @@ and IEEE-754-2008: the result of maxnum(-0.0, +0.0) may be either -0.0 or +0.0.
1710117101

1710217102
Some architectures, such as ARMv8 (FMAXNM), LoongArch (fmax), MIPSr6 (max.fmt), PowerPC/VSX (xsmaxdp),
1710317103
have instructions that match these semantics exactly; thus it is quite simple for these architectures.
17104-
Some architectures have similiar ones while they are not exact equivalent. Such as x86 implements ``MAXPS``,
17104+
Some architectures have similar ones while they are not exact equivalent. Such as x86 implements ``MAXPS``,
1710517105
which implements the semantics of C code ``a>b?a:b``: NUM vs qNaN always return qNaN. ``MAXPS`` can be used
1710617106
if ``nsz`` and ``nnan`` are given.
1710717107

1710817108
For existing libc implementations, the behaviors of fmin may be quite different on sNaN and signed zero behaviors,
17109-
even in the same release of a single libm implemention.
17109+
even in the same release of a single libm implementation.
1711017110

1711117111
.. _i_minimum:
1711217112

llvm/docs/MLGO.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ This document is an outline of the tooling and APIs facilitating MLGO.
1717

1818
Note that tools for orchestrating ML training are not part of LLVM, as they are
1919
dependency-heavy - both on the ML infrastructure choice, as well as choices of
20-
distrubuted computing. For the training scenario, LLVM only contains facilities
20+
distributed computing. For the training scenario, LLVM only contains facilities
2121
enabling it, such as corpus extraction, training data extraction, and evaluation
2222
of models during training.
2323

@@ -212,7 +212,7 @@ decisions.
212212
For a specific optimization problem - i.e. inlining, or regalloc eviction - we
213213
first separate correctness - preserving decisions from optimization decisions.
214214
For example, not inlining functions marked "no inline" is an example of the
215-
former. Same is not evicting an unevictable live range. An exmple of the latter
215+
former. Same is not evicting an unevictable live range. An example of the latter
216216
is deciding to inline a function that will bloat the caller size, just because
217217
we have reason to believe that later, the effect will be some constant
218218
propagation that will actually reduce the size (or dynamic instruction count).

llvm/docs/MemoryModelRelaxationAnnotations.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -338,7 +338,7 @@ In the above figure, ``X`` and ``Y`` are atomic operations on a
338338
location in the ``global`` address space. If ``X`` synchronizes with
339339
``Y``, then ``B`` happens-before ``C`` in the ``local`` address
340340
space. But no such statement can be made about operations ``A`` and
341-
``D``, although they are peformed on a location in the ``global``
341+
``D``, although they are performed on a location in the ``global``
342342
address space.
343343

344344
Implementation Example: Adding Address Space Information to Fences

llvm/docs/MyFirstTypoFix.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -360,7 +360,7 @@ changed.
360360
Within a few days, someone should start the review. They may add
361361
themselves as a reviewer, or simply start leaving comments. You'll get
362362
another email any time the review is updated. For more detail see the
363-
:ref:`Code Review Poilicy <code_review_policy>`.
363+
:ref:`Code Review Policy <code_review_policy>`.
364364

365365
Comments
366366
~~~~~~~~

llvm/docs/NVPTXUsage.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -385,7 +385,7 @@ Semantics:
385385
""""""""""
386386

387387
Before the absolute value is taken, the input is flushed to sign preserving
388-
zero if it is a subnormal. In addtion, unlike '``llvm.fabs.*``', a NaN input
388+
zero if it is a subnormal. In addition, unlike '``llvm.fabs.*``', a NaN input
389389
yields an unspecified NaN output.
390390

391391

@@ -473,7 +473,7 @@ Overview:
473473

474474
The '``llvm.nvvm.fshl.clamp``' family of intrinsics performs a clamped funnel
475475
shift left. These intrinsics are very similar to '``llvm.fshl``', except the
476-
shift ammont is clamped at the integer width (instead of modulo it). Currently,
476+
shift amount is clamped at the integer width (instead of modulo it). Currently,
477477
only ``i32`` is supported.
478478

479479
Semantics:
@@ -501,7 +501,7 @@ Overview:
501501

502502
The '``llvm.nvvm.fshr.clamp``' family of intrinsics perform a clamped funnel
503503
shift right. These intrinsics are very similar to '``llvm.fshr``', except the
504-
shift ammont is clamped at the integer width (instead of modulo it). Currently,
504+
shift amount is clamped at the integer width (instead of modulo it). Currently,
505505
only ``i32`` is supported.
506506

507507
Semantics:

llvm/docs/OpaquePointers.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ Pointee types provide some value to frontends because the IR verifier uses types
7171
to detect straightforward type confusion bugs. However, frontends also have to
7272
deal with the complexity of inserting bitcasts everywhere that they might be
7373
required. The community consensus is that the costs of pointee types
74-
outweight the benefits, and that they should be removed.
74+
outweigh the benefits, and that they should be removed.
7575

7676
Many operations do not actually care about the underlying type. These
7777
operations, typically intrinsics, usually end up taking an arbitrary pointer

llvm/docs/RISCVUsage.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -306,7 +306,7 @@ Supported
306306
.. _riscv-zacas-note:
307307

308308
``Zacas``
309-
The compiler will not generate amocas.d on RV32 or amocas.q on RV64 due to ABI compatibilty. These can only be used in the assembler.
309+
The compiler will not generate amocas.d on RV32 or amocas.q on RV64 due to ABI compatibility. These can only be used in the assembler.
310310

311311
Atomics ABIs
312312
============

llvm/docs/Vectorizers.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -346,7 +346,7 @@ instruction is available.
346346
}
347347
348348
Many of these math functions are only vectorizable if the file has been built
349-
with a specified target vector library that provides a vector implemention
349+
with a specified target vector library that provides a vector implementation
350350
of that math function. Using clang, this is handled by the "-fveclib" command
351351
line option with one of the following vector libraries:
352352
"accelerate,libmvec,massv,svml,sleef,darwin_libsystem_m,armpl,amdlibm"

llvm/docs/XRayFDRFormat.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ produced the trace file.
3535
Header Section
3636
==============
3737

38-
A trace file begins with a 32 byte header.
38+
A trace file begins with a 32-byte header.
3939

4040
+-------------------+-----------------+----------------------------------------+
4141
| Field | Size (bytes) | Description |
@@ -119,7 +119,7 @@ attempt to pad for alignment, and it is not seekable.
119119
Function Records
120120
----------------
121121

122-
Function Records have an 8 byte layout. This layout encodes information to
122+
Function Records have an 8-byte layout. This layout encodes information to
123123
reconstruct a call stack of instrumented function and their durations.
124124

125125
+---------------+--------------+-----------------------------------------------+
@@ -178,7 +178,7 @@ records for each of the logged args follow the function record in the stream.
178178
Metadata Records
179179
----------------
180180

181-
Interspersed throughout the buffer are 16 byte Metadata records. For typically
181+
Interspersed throughout the buffer are 16-byte Metadata records. For typically
182182
instrumented binaries, they will be sparser than Function records, and they
183183
provide a fuller picture of the binary execution state.
184184

0 commit comments

Comments
 (0)