Skip to content

Commit 20c60df

Browse files
[llvm] Proofread TableGen/BackEnds.rst
1 parent 558d935 commit 20c60df

File tree

1 file changed

+25
-25
lines changed

1 file changed

+25
-25
lines changed

llvm/docs/TableGen/BackEnds.rst

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ the TableGen files, the back-ends and their users.
4848
For instance, a global contract is that each back-end produces macro-guarded
4949
sections. Based on whether the file is included by a header or a source file,
5050
or even in which context of each file the include is being used, you have
51-
todefine a macro just before including it, to get the right output:
51+
to define a macro just before including it, to get the right output:
5252

5353
.. code-block:: c++
5454

@@ -80,8 +80,8 @@ in the TableGen files.
8080
CodeEmitter
8181
-----------
8282

83-
**Purpose**: CodeEmitterGen uses the descriptions of instructions and their fields to
84-
construct an automated code emitter: a function that, given a MachineInstr,
83+
**Purpose**: ``CodeEmitterGen`` uses the descriptions of instructions and their fields to
84+
construct an automated code emitter: a function that, given a ``MachineInstr``,
8585
returns the (currently, 32-bit unsigned) value of the instruction.
8686

8787
**Output**: C++ code, implementing the target's CodeEmitter
@@ -130,7 +130,7 @@ AsmMatcher
130130
----------
131131

132132
**Purpose**: Emits a target specifier matcher for
133-
converting parsed assembly operands in the MCInst structures. It also
133+
converting parsed assembly operands in the ``MCInst`` structures. It also
134134
emits a matcher for custom operand parsing. Extensive documentation is
135135
written on the ``AsmMatcherEmitter.cpp`` file.
136136

@@ -167,7 +167,7 @@ CallingConv
167167
conventions supported by this target.
168168

169169
**Output**: Implement static functions to deal with calling conventions
170-
chained by matching styles, returning false on no match.
170+
chained by matching styles, returning ``false`` on no match.
171171

172172
**Usage**: Used in ISelLowering and FastIsel as function pointers to
173173
implementation returned by a CC selection function.
@@ -200,7 +200,7 @@ FastISel
200200

201201
**Purpose**: This tablegen backend emits code for use by the "fast"
202202
instruction selection algorithm. See the comments at the top of
203-
lib/CodeGen/SelectionDAG/FastISel.cpp for background. This file
203+
``lib/CodeGen/SelectionDAG/FastISel.cpp`` for background. This file
204204
scans through the target's tablegen instruction-info files
205205
and extracts instructions with obvious-looking patterns, and it emits
206206
code to look up these instructions by type and operator.
@@ -270,23 +270,23 @@ This file is included as part of ``Attr.h``.
270270
ClangAttrParserStringSwitches
271271
-----------------------------
272272

273-
**Purpose**: Creates AttrParserStringSwitches.inc, which contains
274-
StringSwitch::Case statements for parser-related string switches. Each switch
273+
**Purpose**: Creates ``AttrParserStringSwitches.inc``, which contains
274+
``StringSwitch::Case`` statements for parser-related string switches. Each switch
275275
is given its own macro (such as ``CLANG_ATTR_ARG_CONTEXT_LIST``, or
276276
``CLANG_ATTR_IDENTIFIER_ARG_LIST``), which is expected to be defined before
277-
including AttrParserStringSwitches.inc, and undefined after.
277+
including ``AttrParserStringSwitches.inc``, and undefined after.
278278

279279
ClangAttrImpl
280280
-------------
281281

282-
**Purpose**: Creates AttrImpl.inc, which contains semantic attribute class
282+
**Purpose**: Creates ``AttrImpl.inc``, which contains semantic attribute class
283283
definitions for any attribute in ``Attr.td`` that has not set ``ASTNode = 0``.
284284
This file is included as part of ``AttrImpl.cpp``.
285285

286286
ClangAttrList
287287
-------------
288288

289-
**Purpose**: Creates AttrList.inc, which is used when a list of semantic
289+
**Purpose**: Creates ``AttrList.inc``, which is used when a list of semantic
290290
attribute identifiers is required. For instance, ``AttrKinds.h`` includes this
291291
file to generate the list of ``attr::Kind`` enumeration values. This list is
292292
separated out into multiple categories: attributes, inheritable attributes, and
@@ -297,25 +297,25 @@ functionality required for ``dyn_cast`` and similar APIs.
297297
ClangAttrPCHRead
298298
----------------
299299

300-
**Purpose**: Creates AttrPCHRead.inc, which is used to deserialize attributes
300+
**Purpose**: Creates ``AttrPCHRead.inc``, which is used to deserialize attributes
301301
in the ``ASTReader::ReadAttributes`` function.
302302

303303
ClangAttrPCHWrite
304304
-----------------
305305

306-
**Purpose**: Creates AttrPCHWrite.inc, which is used to serialize attributes in
306+
**Purpose**: Creates ``AttrPCHWrite.inc``, which is used to serialize attributes in
307307
the ``ASTWriter::WriteAttributes`` function.
308308

309309
ClangAttrSpellings
310310
---------------------
311311

312-
**Purpose**: Creates AttrSpellings.inc, which is used to implement the
312+
**Purpose**: Creates ``AttrSpellings.inc``, which is used to implement the
313313
``__has_attribute`` feature test macro.
314314

315315
ClangAttrSpellingListIndex
316316
--------------------------
317317

318-
**Purpose**: Creates AttrSpellingListIndex.inc, which is used to map parsed
318+
**Purpose**: Creates ``AttrSpellingListIndex.inc``, which is used to map parsed
319319
attribute spellings (including which syntax or scope was used) to an attribute
320320
spelling list index. These spelling list index values are internal
321321
implementation details exposed via
@@ -324,41 +324,41 @@ implementation details exposed via
324324
ClangAttrVisitor
325325
-------------------
326326

327-
**Purpose**: Creates AttrVisitor.inc, which is used when implementing
327+
**Purpose**: Creates ``AttrVisitor.inc``, which is used when implementing
328328
recursive AST visitors.
329329

330330
ClangAttrTemplateInstantiate
331331
----------------------------
332332

333-
**Purpose**: Creates AttrTemplateInstantiate.inc, which implements the
333+
**Purpose**: Creates ``AttrTemplateInstantiate.inc``, which implements the
334334
``instantiateTemplateAttribute`` function, used when instantiating a template
335335
that requires an attribute to be cloned.
336336

337337
ClangAttrParsedAttrList
338338
-----------------------
339339

340-
**Purpose**: Creates AttrParsedAttrList.inc, which is used to generate the
340+
**Purpose**: Creates ``AttrParsedAttrList.inc``, which is used to generate the
341341
``AttributeList::Kind`` parsed attribute enumeration.
342342

343343
ClangAttrParsedAttrImpl
344344
-----------------------
345345

346-
**Purpose**: Creates AttrParsedAttrImpl.inc, which is used by
346+
**Purpose**: Creates ``AttrParsedAttrImpl.inc``, which is used by
347347
``AttributeList.cpp`` to implement several functions on the ``AttributeList``
348348
class. This functionality is implemented via the ``AttrInfoMap ParsedAttrInfo``
349349
array, which contains one element per parsed attribute object.
350350

351351
ClangAttrParsedAttrKinds
352352
------------------------
353353

354-
**Purpose**: Creates AttrParsedAttrKinds.inc, which is used to implement the
354+
**Purpose**: Creates ``AttrParsedAttrKinds.inc``, which is used to implement the
355355
``AttributeList::getKind`` function, mapping a string (and syntax) to a parsed
356356
attribute ``AttributeList::Kind`` enumeration.
357357

358358
ClangAttrDump
359359
-------------
360360

361-
**Purpose**: Creates AttrDump.inc, which dumps information about an attribute.
361+
**Purpose**: Creates ``AttrDump.inc``, which dumps information about an attribute.
362362
It is used to implement ``ASTDumper::dumpAttr``.
363363

364364
ClangDiagsDefs
@@ -424,7 +424,7 @@ Generate list of commands that are used in documentation comments.
424424
ArmNeon
425425
-------
426426

427-
Generate arm_neon.h for clang.
427+
Generate ``arm_neon.h`` for clang.
428428

429429
ArmNeonSema
430430
-----------
@@ -473,7 +473,7 @@ to a built-in backend.
473473

474474
**Output**:
475475

476-
The root of the output file is a JSON object (i.e. dictionary),
476+
The root of the output file is a JSON object (i.e., dictionary),
477477
containing the following fixed keys:
478478

479479
* ``!tablegen_json_version``: a numeric version field that will
@@ -520,7 +520,7 @@ conventions described below.
520520
Some TableGen data types are translated directly into the
521521
corresponding JSON type:
522522

523-
* A completely undefined value (e.g. for a variable declared without
523+
* A completely undefined value (e.g., for a variable declared without
524524
initializer in some superclass of this record, and never initialized
525525
by the record itself or any other superclass) is emitted as the JSON
526526
``null`` value.
@@ -964,7 +964,7 @@ Here is the modified lookup function.
964964
965965
The new lookup function will return an iterator range with first pointer to the
966966
first result and the last pointer to the last matching result from the table.
967-
However, please note that the support for emitting modified definition exists
967+
However, please note that the support for emitting a modified definition exists
968968
for ``PrimaryKeyName`` only.
969969

970970
The ``PrimaryKeyEarlyOut`` field, when set to 1, modifies the lookup

0 commit comments

Comments
 (0)