Skip to content

Commit f65d4aa

Browse files
kiszktclin914
authored andcommitted
[llvm] NFC: fix trivial typos in documents
Reviewers: hans, Jim Reviewed By: Jim Subscribers: jvesely, nhaehnle, mgorny, arphaman, bmahjour, kerbowa, llvm-commits Tags: #llvm Differential Revision: https://reviews.llvm.org/D73017
1 parent 62e4b50 commit f65d4aa

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

48 files changed

+84
-84
lines changed

llvm/docs/AMDGPU/AMDGPUAsmGFX10.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@ Notation
2222

2323
Notation used in this document is explained :ref:`here<amdgpu_syn_instruction_notation>`.
2424

25-
Overvew
26-
=======
25+
Overview
26+
========
2727

2828
An overview of generic syntax and other features of AMDGPU instructions may be found :ref:`in this document<amdgpu_syn_instructions>`.
2929

llvm/docs/AMDGPU/AMDGPUAsmGFX7.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@ Notation
2222

2323
Notation used in this document is explained :ref:`here<amdgpu_syn_instruction_notation>`.
2424

25-
Overvew
26-
=======
25+
Overview
26+
========
2727

2828
An overview of generic syntax and other features of AMDGPU instructions may be found :ref:`in this document<amdgpu_syn_instructions>`.
2929

llvm/docs/AMDGPU/AMDGPUAsmGFX8.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@ Notation
2222

2323
Notation used in this document is explained :ref:`here<amdgpu_syn_instruction_notation>`.
2424

25-
Overvew
26-
=======
25+
Overview
26+
========
2727

2828
An overview of generic syntax and other features of AMDGPU instructions may be found :ref:`in this document<amdgpu_syn_instructions>`.
2929

llvm/docs/AMDGPU/AMDGPUAsmGFX9.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@ Notation
2222

2323
Notation used in this document is explained :ref:`here<amdgpu_syn_instruction_notation>`.
2424

25-
Overvew
26-
=======
25+
Overview
26+
========
2727

2828
An overview of generic syntax and other features of AMDGPU instructions may be found :ref:`in this document<amdgpu_syn_instructions>`.
2929

llvm/docs/AMDGPU/AMDGPUAsmGFX900.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,8 @@ Notation
2424

2525
Notation used in this document is explained :ref:`here<amdgpu_syn_instruction_notation>`.
2626

27-
Overvew
28-
=======
27+
Overview
28+
========
2929

3030
An overview of generic syntax and other features of AMDGPU instructions may be found :ref:`in this document<amdgpu_syn_instructions>`.
3131

llvm/docs/AMDGPU/AMDGPUAsmGFX904.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,8 @@ Notation
2424

2525
Notation used in this document is explained :ref:`here<amdgpu_syn_instruction_notation>`.
2626

27-
Overvew
28-
=======
27+
Overview
28+
========
2929

3030
An overview of generic syntax and other features of AMDGPU instructions may be found :ref:`in this document<amdgpu_syn_instructions>`.
3131

llvm/docs/AMDGPU/AMDGPUAsmGFX906.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,8 @@ Notation
2424

2525
Notation used in this document is explained :ref:`here<amdgpu_syn_instruction_notation>`.
2626

27-
Overvew
28-
=======
27+
Overview
28+
========
2929

3030
An overview of generic syntax and other features of AMDGPU instructions may be found :ref:`in this document<amdgpu_syn_instructions>`.
3131

llvm/docs/AMDGPU/AMDGPUAsmGFX908.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,8 @@ Notation
2424

2525
Notation used in this document is explained :ref:`here<amdgpu_syn_instruction_notation>`.
2626

27-
Overvew
28-
=======
27+
Overview
28+
========
2929

3030
An overview of generic syntax and other features of AMDGPU instructions may be found :ref:`in this document<amdgpu_syn_instructions>`.
3131

llvm/docs/Atomics.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -562,7 +562,7 @@ various reasons, it is not practical to emit the instructions inline.
562562

563563
There's two typical examples of this.
564564

565-
Some CPUs support multiple instruction sets which can be swiched back and forth
565+
Some CPUs support multiple instruction sets which can be switched back and forth
566566
on function-call boundaries. For example, MIPS supports the MIPS16 ISA, which
567567
has a smaller instruction encoding than the usual MIPS32 ISA. ARM, similarly,
568568
has the Thumb ISA. In MIPS16 and earlier versions of Thumb, the atomic

llvm/docs/BigEndianNEON.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Generating code for big endian ARM processors is for the most part straightforwa
1212

1313
The aim of this document is to explain the problem with NEON loads and stores, and the solution that has been implemented in LLVM.
1414

15-
In this document the term "vector" refers to what the ARM ABI calls a "short vector", which is a sequence of items that can fit in a NEON register. This sequence can be 64 or 128 bits in length, and can constitute 8, 16, 32 or 64 bit items. This document refers to A64 instructions throughout, but is almost applicable to the A32/ARMv7 instruction sets also. The ABI format for passing vectors in A32 is sligtly different to A64. Apart from that, the same concepts apply.
15+
In this document the term "vector" refers to what the ARM ABI calls a "short vector", which is a sequence of items that can fit in a NEON register. This sequence can be 64 or 128 bits in length, and can constitute 8, 16, 32 or 64 bit items. This document refers to A64 instructions throughout, but is almost applicable to the A32/ARMv7 instruction sets also. The ABI format for passing vectors in A32 is slightly different to A64. Apart from that, the same concepts apply.
1616

1717
Example: C-level intrinsics -> assembly
1818
---------------------------------------

llvm/docs/BlockFrequencyTerminology.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ by a cut edge should equal ``UINT64_MAX``. In other words, mass is conserved
8282
as it "falls" through the DAG.
8383

8484
If a function's basic block graph is a DAG, then block masses are valid block
85-
frequencies. This works poorly in practise though, since downstream users rely
85+
frequencies. This works poorly in practice though, since downstream users rely
8686
on adding block frequencies together without hitting the maximum.
8787

8888
Loop Scale

llvm/docs/Bugpoint.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ non-obvious ways. Here are some hints and tips:
121121
miscompilation. Programs should be temporarily modified to disable outputs
122122
that are likely to vary from run to run.
123123

124-
* In the `crash debugger`_, ``bugpoint`` does not distiguish different crashes
124+
* In the `crash debugger`_, ``bugpoint`` does not distinguish different crashes
125125
during reduction. Thus, if new crash or miscompilation happens, ``bugpoint``
126126
will continue with the new crash instead. If you would like to stick to
127127
particular crash, you should write check scripts to validate the error

llvm/docs/CMakePrimer.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -333,7 +333,7 @@ When defining a CMake command handling arguments is very useful. The examples
333333
in this section will all use the CMake ``function`` block, but this all applies
334334
to the ``macro`` block as well.
335335

336-
CMake commands can have named arguments that are requried at every call site. In
336+
CMake commands can have named arguments that are required at every call site. In
337337
addition, all commands will implicitly accept a variable number of extra
338338
arguments (In C parlance, all commands are varargs functions). When a command is
339339
invoked with extra arguments (beyond the named ones) CMake will store the full

llvm/docs/CodeGenerator.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -1272,7 +1272,7 @@ compatible with a given physical, this code can be used:
12721272

12731273
Sometimes, mostly for debugging purposes, it is useful to change the number of
12741274
physical registers available in the target architecture. This must be done
1275-
statically, inside the ``TargetRegsterInfo.td`` file. Just ``grep`` for
1275+
statically, inside the ``TargetRegisterInfo.td`` file. Just ``grep`` for
12761276
``RegisterClass``, the last parameter of which is a list of registers. Just
12771277
commenting some out is one simple way to avoid them being used. A more polite
12781278
way is to explicitly exclude some registers from the *allocation order*. See the
@@ -2418,7 +2418,7 @@ to spill registers r3-r10. This allows callees blind to the call signature,
24182418
such as thunks and vararg functions, enough space to cache the argument
24192419
registers. Therefore, the parameter area is minimally 32 bytes (64 bytes in 64
24202420
bit mode.) Also note that since the parameter area is a fixed offset from the
2421-
top of the frame, that a callee can access its spilt arguments using fixed
2421+
top of the frame, that a callee can access its split arguments using fixed
24222422
offsets from the stack pointer (or base pointer.)
24232423

24242424
Combining the information about the linkage, parameter areas and alignment. A

llvm/docs/CodingStandards.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -647,7 +647,7 @@ Beware of non-deterministic sorting order of equal elements
647647

648648
``std::sort`` uses a non-stable sorting algorithm in which the order of equal
649649
elements is not guaranteed to be preserved. Thus using ``std::sort`` for a
650-
container having equal elements may result in non-determinstic behavior.
650+
container having equal elements may result in non-deterministic behavior.
651651
To uncover such instances of non-determinism, LLVM has introduced a new
652652
llvm::sort wrapper function. For an EXPENSIVE_CHECKS build this will randomly
653653
shuffle the container before sorting. Default to using ``llvm::sort`` instead
@@ -1206,7 +1206,7 @@ Don't evaluate ``end()`` every time through a loop
12061206

12071207
In cases where range-based ``for`` loops can't be used and it is necessary
12081208
to write an explicit iterator-based loop, pay close attention to whether
1209-
``end()`` is re-evaluted on each loop iteration. One common mistake is to
1209+
``end()`` is re-evaluated on each loop iteration. One common mistake is to
12101210
write a loop in this style:
12111211

12121212
.. code-block:: c++

llvm/docs/CommandGuide/lit.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -176,7 +176,7 @@ SELECTION OPTIONS
176176
"shards", and run only one of them. Must be used with the
177177
``--run-shard=N`` option, which selects the shard to run. The environment
178178
variable ``LIT_NUM_SHARDS`` can also be used in place of this
179-
option. These two options provide a coarse mechanism for paritioning large
179+
option. These two options provide a coarse mechanism for partitioning large
180180
testsuites, for parallel execution on separate machines (say in a large
181181
testing farm).
182182

llvm/docs/CommandGuide/tblgen.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ OPTIONS
9898

9999
.. option:: -gen-dag-isel
100100

101-
Generate a DAG (Directed Acycle Graph) instruction selector.
101+
Generate a DAG (Directed Acyclic Graph) instruction selector.
102102

103103
.. option:: -gen-asm-matcher
104104

llvm/docs/CompileCudaWithLLVM.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -512,7 +512,7 @@ LLVM to make it generate good GPU code. Among these changes are:
512512

513513
* `Memory space inference
514514
<http://llvm.org/doxygen/NVPTXInferAddressSpaces_8cpp_source.html>`_ --
515-
In PTX, we can operate on pointers that are in a paricular "address space"
515+
In PTX, we can operate on pointers that are in a particular "address space"
516516
(global, shared, constant, or local), or we can operate on pointers in the
517517
"generic" address space, which can point to anything. Operations in a
518518
non-generic address space are faster, but pointers in CUDA are not explicitly
@@ -528,7 +528,7 @@ LLVM to make it generate good GPU code. Among these changes are:
528528
which fit in 32-bits at runtime. This optimization provides a fast path for
529529
this common case.
530530

531-
* Aggressive loop unrooling and function inlining -- Loop unrolling and
531+
* Aggressive loop unrolling and function inlining -- Loop unrolling and
532532
function inlining need to be more aggressive for GPUs than for CPUs because
533533
control flow transfer in GPU is more expensive. More aggressive unrolling and
534534
inlining also promote other optimizations, such as constant propagation and

llvm/docs/CoverageMappingFormat.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Introduction
1212
============
1313

1414
LLVM's code coverage mapping format is used to provide code coverage
15-
analysis using LLVM's and Clang's instrumenation based profiling
15+
analysis using LLVM's and Clang's instrumentation based profiling
1616
(Clang's ``-fprofile-instr-generate`` option).
1717

1818
This document is aimed at those who use LLVM's code coverage mapping to provide

llvm/docs/DependenceGraphs/index.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ graph described in [1]_ in the following ways:
131131

132132
1. The graph nodes in the paper represent three main program components, namely *assignment statements*, *for loop headers* and *while loop headers*. In this implementation, DDG nodes naturally represent LLVM IR instructions. An assignment statement in this implementation typically involves a node representing the ``store`` instruction along with a number of individual nodes computing the right-hand-side of the assignment that connect to the ``store`` node via a def-use edge. The loop header instructions are not represented as special nodes in this implementation because they have limited uses and can be easily identified, for example, through ``LoopAnalysis``.
133133
2. The paper describes five types of dependency edges between nodes namely *loop dependency*, *flow-*, *anti-*, *output-*, and *input-* dependencies. In this implementation *memory* edges represent the *flow-*, *anti-*, *output-*, and *input-* dependencies. However, *loop dependencies* are not made explicit, because they mainly represent association between a loop structure and the program elements inside the loop and this association is fairly obvious in LLVM IR itself.
134-
3. The paper describes two types of pi-blocks; *recurrences* whose bodies are SCCs and *IN* nodes whose bodies are not part of any SCC. In this impelmentation, pi-blocks are only created for *recurrences*. *IN* nodes remain as simple DDG nodes in the graph.
134+
3. The paper describes two types of pi-blocks; *recurrences* whose bodies are SCCs and *IN* nodes whose bodies are not part of any SCC. In this implementation, pi-blocks are only created for *recurrences*. *IN* nodes remain as simple DDG nodes in the graph.
135135

136136

137137
References

llvm/docs/DeveloperPolicy.rst

+4-4
Original file line numberDiff line numberDiff line change
@@ -384,8 +384,8 @@ after they are committed, depending on the nature of the change). You are
384384
encouraged to review other peoples' patches as well, but you aren't required
385385
to do so.
386386

387-
Current Contributors - Transfering from SVN
388-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
387+
Current Contributors - Transferring from SVN
388+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
389389
If you had commit access to SVN and would like to request commit access to
390390
GitHub, please email `llvm-admin <mailto:[email protected]>`_ with your
391391
SVN username and GitHub username.
@@ -744,7 +744,7 @@ OpenMP, etc), Polly, and all other subprojects. There are a few exceptions:
744744
is used by LLVM.
745745
* Some subprojects are impractical or uninteresting to relicense (e.g. llvm-gcc
746746
and dragonegg). These will be split off from the LLVM project (e.g. to
747-
separate Github projects), allowing interested people to continue their
747+
separate GitHub projects), allowing interested people to continue their
748748
development elsewhere.
749749

750750
To relicense LLVM, we will be seeking approval from all of the copyright holders
@@ -875,7 +875,7 @@ holds though)::
875875

876876
Q2: If at any time after my contribution, I am able to license other patent
877877
claims that would have been subject to Apache's Grant of Patent License if
878-
they were licenseable by me at the time of my contribution, do those other
878+
they were licensable by me at the time of my contribution, do those other
879879
claims become subject to the Grant of Patent License?
880880

881881
A2: Yes.

llvm/docs/Extensions.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -213,7 +213,7 @@ ELF-Dependent
213213
^^^^^^^^^^^^^^^^^^^^^^
214214

215215
In order to support creating multiple sections with the same name and comdat,
216-
it is possible to add an unique number at the end of the ``.seciton`` directive.
216+
it is possible to add an unique number at the end of the ``.section`` directive.
217217
For example, the following code creates two sections named ``.text``.
218218

219219
.. code-block:: gas

llvm/docs/Frontend/PerformanceTips.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -255,7 +255,7 @@ couple specific suggestions:
255255

256256
#. For languages with numerous rarely executed guard conditions (e.g. null
257257
checks, type checks, range checks) consider adding an extra execution or
258-
two of LoopUnswith and LICM to your pass order. The standard pass order,
258+
two of LoopUnswitch and LICM to your pass order. The standard pass order,
259259
which is tuned for C and C++ applications, may not be sufficient to remove
260260
all dischargeable checks from loops.
261261

llvm/docs/FuzzingLLVM.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ llvm-opt-fuzzer
106106

107107
A |LLVM IR fuzzer| aimed at finding bugs in optimization passes.
108108

109-
It receives optimzation pipeline and runs it for each fuzzer input.
109+
It receives optimization pipeline and runs it for each fuzzer input.
110110

111111
Interface of this fuzzer almost directly mirrors ``llvm-isel-fuzzer``. Both
112112
``mtriple`` and ``passes`` arguments are required. Passes are specified in a

llvm/docs/GettingStarted.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -599,7 +599,7 @@ used by people developing LLVM.
599599
| | overridden with ``LLVM_DYLIB_COMPONENTS``. The |
600600
| | default contains most of LLVM and is defined in |
601601
| | ``tools/llvm-shlib/CMakelists.txt``. This option is|
602-
| | not avialable on Windows. |
602+
| | not available on Windows. |
603603
+-------------------------+----------------------------------------------------+
604604
| LLVM_OPTIMIZED_TABLEGEN | Builds a release tablegen that gets used during |
605605
| | the LLVM build. This can dramatically speed up |

llvm/docs/GlobalISel/GenericOpcode.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -633,7 +633,7 @@ G_INTRINSIC, G_INTRINSIC_W_SIDE_EFFECTS
633633
Call an intrinsic
634634

635635
The _W_SIDE_EFFECTS version is considered to have unknown side-effects and
636-
as such cannot be reordered acrosss other side-effecting instructions.
636+
as such cannot be reordered across other side-effecting instructions.
637637

638638
.. note::
639639

llvm/docs/GwpAsan.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ Allocator Support
5555
GWP-ASan is not a replacement for a traditional allocator. Instead, it works by
5656
inserting stubs into a supporting allocator to redirect allocations to GWP-ASan
5757
when they're chosen to be sampled. These stubs are generally implemented in the
58-
implementaion of ``malloc()``, ``free()`` and ``realloc()``. The stubs are
58+
implementation of ``malloc()``, ``free()`` and ``realloc()``. The stubs are
5959
extremely small, which makes using GWP-ASan in most allocators fairly trivial.
6060
The stubs follow the same general pattern (example ``malloc()`` pseudocode
6161
below):

llvm/docs/HowToBuildOnARM.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ on the ARMv6 and ARMv7 architectures and may be inapplicable to older chips.
2222
Pandaboard, have become hard-float platforms. There are a number of
2323
choices when using CMake. Autoconf usage is deprecated as of 3.8.
2424

25-
Building LLVM/Clang in ``Relese`` mode is preferred since it consumes
25+
Building LLVM/Clang in ``Release`` mode is preferred since it consumes
2626
a lot less memory. Otherwise, the building process will very likely
2727
fail due to insufficient memory. It's also a lot quicker to only build
2828
the relevant back-ends (ARM and AArch64), since it's very unlikely that
@@ -42,7 +42,7 @@ on the ARMv6 and ARMv7 architectures and may be inapplicable to older chips.
4242
Use Ninja instead of Make: "-G Ninja"
4343
Build with assertions on: "-DLLVM_ENABLE_ASSERTIONS=True"
4444
Force Python2: "-DPYTHON_EXECUTABLE=/usr/bin/python2"
45-
Local (non-sudo) install path: "-DCMAKE_INSTALL_PREFIX=$HOME/llvm/instal"
45+
Local (non-sudo) install path: "-DCMAKE_INSTALL_PREFIX=$HOME/llvm/install"
4646
CPU flags: "DCMAKE_C_FLAGS=-mcpu=cortex-a15" (same for CXX_FLAGS)
4747

4848
After that, just typing ``make -jN`` or ``ninja`` will build everything.

llvm/docs/HowToCrossCompileBuiltinsOnArm.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ compiler-rt must be placed in the runtimes directory.
4343

4444
``qemu-arm`` should be available as a package for your Linux distribution.
4545

46-
The most complicated of the prequisites to satisfy is the arm-linux-gnueabihf
46+
The most complicated of the prerequisites to satisfy is the arm-linux-gnueabihf
4747
sysroot. In theory it is possible to use the Linux distributions multiarch
4848
support to fulfill the dependencies for building but unfortunately due to
4949
/usr/local/include being added some host includes are selected. The easiest way

0 commit comments

Comments
 (0)