Skip to content

Commit 81309d5

Browse files
[llvm] Proofread ExtendingLLVM.rst (#160646)
1 parent 78238dc commit 81309d5

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

llvm/docs/ExtendingLLVM.rst

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ function, or a whole new instruction.
1313

1414
When you come to this realization, stop and think. Do you really need to extend
1515
LLVM? Is it a new fundamental capability that LLVM does not support at its
16-
current incarnation or can it be synthesized from already pre-existing LLVM
16+
current incarnation or can it be synthesized from existing LLVM
1717
elements? If you are not sure, ask on the `LLVM forums
1818
<https://discourse.llvm.org>`_. The reason is that
1919
extending LLVM will get involved as you need to update all the different passes
@@ -27,7 +27,7 @@ method of choice for LLVM extension.
2727

2828
Before you invest a significant amount of effort into a non-trivial extension,
2929
**ask on the list** if what you are looking to do can be done with
30-
already-existing infrastructure, or if maybe someone else is already working on
30+
existing infrastructure, or if maybe someone else is already working on
3131
it. You will save yourself a lot of time and effort by doing so.
3232

3333
.. _intrinsic function:
@@ -57,12 +57,12 @@ function and then be turned into an instruction if warranted.
5757

5858
#. ``llvm/lib/Analysis/ConstantFolding.cpp``:
5959

60-
If it is possible to constant fold your intrinsic, add support to it in the
60+
If it is possible to constant fold your intrinsic, add support for it in the
6161
``canConstantFoldCallTo`` and ``ConstantFoldCall`` functions.
6262

6363
#. ``llvm/test/*``:
6464

65-
Add test cases for your test cases to the test suite
65+
Add test cases for your intrinsic to the test suite
6666

6767
Once the intrinsic has been added to the system, you must add code generator
6868
support for it. Generally you must do the following steps:
@@ -72,7 +72,7 @@ Add support to the .td file for the target(s) of your choice in
7272

7373
This is usually a matter of adding a pattern to the .td file that matches the
7474
intrinsic, though it may obviously require adding the instructions you want to
75-
generate as well. There are lots of examples in the PowerPC and X86 backend
75+
generate as well. There are lots of examples in the PowerPC and X86 backends
7676
to follow.
7777

7878
Adding a new SelectionDAG node
@@ -194,7 +194,7 @@ Adding a new instruction
194194

195195
#. ``llvm/lib/AsmParser/LLLexer.cpp``:
196196

197-
add a new token to parse your instruction from assembly text file
197+
add a new token to parse your instruction from an assembly text file
198198

199199
#. ``llvm/lib/AsmParser/LLParser.cpp``:
200200

@@ -207,7 +207,7 @@ Adding a new instruction
207207

208208
#. ``llvm/lib/Bitcode/Writer/BitcodeWriter.cpp``:
209209

210-
add a case for your instruction and how it will be parsed from bitcode
210+
add a case for your instruction and how it will be written to bitcode
211211

212212
#. ``llvm/lib/IR/Instruction.cpp``:
213213

@@ -236,7 +236,7 @@ Adding a new type
236236
.. warning::
237237

238238
Adding new types changes the bitcode format, and will break compatibility with
239-
currently-existing LLVM installations. Only add new types if it is absolutely
239+
existing LLVM installations. Only add new types if it is absolutely
240240
necessary.
241241

242242
Adding a fundamental type
@@ -284,17 +284,17 @@ Adding a derived type
284284

285285
#. ``llvm/include/llvm/IR/DerivedTypes.h``:
286286

287-
add new class to represent new class in the hierarchy; add forward
287+
add a new class to represent the new class in the hierarchy; add forward
288288
declaration to the TypeMap value type
289289

290290
#. ``llvm/lib/IR/Type.cpp`` and ``llvm/lib/CodeGen/ValueTypes.cpp``:
291291

292-
add support for derived type, notably `enum TypeID` and `is`, `get` methods.
292+
add support for derived type, notably ``enum TypeID`` and ``is``, ``get`` methods.
293293

294294
#. ``llvm/include/llvm-c/Core.h`` and ``llvm/lib/IR/Core.cpp``:
295295

296296
add enum ``LLVMTypeKind`` and modify
297-
`LLVMTypeKind LLVMGetTypeKind(LLVMTypeRef Ty)` for the new type
297+
``LLVMTypeKind LLVMGetTypeKind(LLVMTypeRef Ty)`` for the new type
298298

299299
#. ``llvm/lib/AsmParser/LLLexer.cpp``:
300300

0 commit comments

Comments
 (0)