@@ -87,9 +87,9 @@ Fixed Width Integers
87
87
^^^^^^^^^^^^^^^^^^^^
88
88
89
89
Fixed-width integer values have their low bits emitted directly to the file.
90
- For example, a 3-bit integer value encodes 1 as 001. Fixed width integers are
90
+ For example, a 3-bit integer value encodes 1 as 001. Fixed- width integers are
91
91
used when there are a well-known number of options for a field. For example,
92
- boolean values are usually encoded with a 1-bit wide integer.
92
+ boolean values are usually encoded with a 1-bit- wide integer.
93
93
94
94
.. _Variable Width Integers :
95
95
.. _Variable Width Integer :
@@ -229,7 +229,7 @@ Data Records
229
229
------------
230
230
231
231
Data records consist of a record code and a number of (up to) 64-bit integer
232
- values. The interpretation of the code and values is application specific and
232
+ values. The interpretation of the code and values is application- specific and
233
233
may vary between different block types. Records can be encoded either using an
234
234
unabbrev record, or with an abbreviation. In the LLVM IR format, for example,
235
235
there is a record which encodes the target triple of a module. The code is
@@ -469,19 +469,19 @@ Native Object File Wrapper Format
469
469
=================================
470
470
471
471
Bitcode files for LLVM IR may also be wrapped in a native object file
472
- (i.e. ELF, COFF, Mach-O). The bitcode must be stored in a section of the object
473
- file named ``__LLVM,__bitcode `` for MachO or ``.llvmbc `` for the other object
472
+ (i.e., ELF, COFF, Mach-O). The bitcode must be stored in a section of the object
473
+ file named ``__LLVM,__bitcode `` for Mach-O or ``.llvmbc `` for the other object
474
474
formats. ELF objects additionally support a ``.llvm.lto `` section for
475
- :doc: `FatLTO `, which contains bitcode suitable for LTO compilation (i.e. bitcode
475
+ :doc: `FatLTO `, which contains bitcode suitable for LTO compilation (i.e., bitcode
476
476
that has gone through a pre-link LTO pipeline). The ``.llvmbc `` section
477
477
predates FatLTO support in LLVM, and may not always contain bitcode that is
478
- suitable for LTO (i.e. from ``-fembed-bitcode ``). The wrapper format is useful
478
+ suitable for LTO (i.e., from ``-fembed-bitcode ``). The wrapper format is useful
479
479
for accommodating LTO in compilation pipelines where intermediate objects must
480
480
be native object files which contain metadata in other sections.
481
481
482
482
Not all tools support this format. For example, lld and the gold plugin will
483
483
ignore the ``.llvmbc `` section when linking object files, but can use
484
- ``.llvm.lto `` sections when passed the correct command line options.
484
+ ``.llvm.lto `` sections when passed the correct command- line options.
485
485
486
486
.. _encoding of LLVM IR :
487
487
@@ -585,7 +585,7 @@ MODULE_CODE_VERSION Record
585
585
``[VERSION, version#] ``
586
586
587
587
The ``VERSION `` record (code 1) contains a single value indicating the format
588
- version. Versions 0, 1 and 2 are supported at this time. The difference between
588
+ version. Versions 0, 1, and 2 are supported at this time. The difference between
589
589
version 0 and 1 is in the encoding of instruction operands in
590
590
each `FUNCTION_BLOCK `_.
591
591
@@ -1033,13 +1033,13 @@ in the file `Attributes.td
1033
1033
.. note ::
1034
1034
The ``allocsize `` attribute has a special encoding for its arguments. Its two
1035
1035
arguments, which are 32-bit integers, are packed into one 64-bit integer value
1036
- (i.e. ``(EltSizeParam << 32) | NumEltsParam ``), with ``NumEltsParam `` taking on
1036
+ (i.e., ``(EltSizeParam << 32) | NumEltsParam ``), with ``NumEltsParam `` taking on
1037
1037
the sentinel value -1 if it is not specified.
1038
1038
1039
1039
.. note ::
1040
1040
The ``vscale_range `` attribute has a special encoding for its arguments. Its two
1041
1041
arguments, which are 32-bit integers, are packed into one 64-bit integer value
1042
- (i.e. ``(Min << 32) | Max ``), with ``Max `` taking on the value of ``Min `` if
1042
+ (i.e., ``(Min << 32) | Max ``), with ``Max `` taking on the value of ``Min `` if
1043
1043
it is not specified.
1044
1044
1045
1045
.. _TYPE_BLOCK :
@@ -1137,7 +1137,7 @@ TYPE_CODE_POINTER Record
1137
1137
``[POINTER, pointee type, address space] ``
1138
1138
1139
1139
The ``POINTER `` record (code 8) adds a pointer type to the type table. The
1140
- operand fields are
1140
+ operand fields are:
1141
1141
1142
1142
* *pointee type *: The type index of the pointed-to type
1143
1143
@@ -1155,7 +1155,7 @@ TYPE_CODE_FUNCTION_OLD Record
1155
1155
``[FUNCTION_OLD, vararg, ignored, retty, ...paramty... ] ``
1156
1156
1157
1157
The ``FUNCTION_OLD `` record (code 9) adds a function type to the type table.
1158
- The operand fields are
1158
+ The operand fields are:
1159
1159
1160
1160
* *vararg *: Non-zero if the type represents a varargs function
1161
1161
@@ -1173,7 +1173,7 @@ TYPE_CODE_ARRAY Record
1173
1173
``[ARRAY, numelts, eltty] ``
1174
1174
1175
1175
The ``ARRAY `` record (code 11) adds an array type to the type table. The
1176
- operand fields are
1176
+ operand fields are:
1177
1177
1178
1178
* *numelts *: The number of elements in arrays of this type
1179
1179
@@ -1185,7 +1185,7 @@ TYPE_CODE_VECTOR Record
1185
1185
``[VECTOR, numelts, eltty] ``
1186
1186
1187
1187
The ``VECTOR `` record (code 12) adds a vector type to the type table. The
1188
- operand fields are
1188
+ operand fields are:
1189
1189
1190
1190
* *numelts *: The number of elements in vectors of this type
1191
1191
@@ -1235,7 +1235,7 @@ TYPE_CODE_STRUCT_ANON Record
1235
1235
``[STRUCT_ANON, ispacked, ...eltty...] ``
1236
1236
1237
1237
The ``STRUCT_ANON `` record (code 18) adds a literal struct type to the type
1238
- table. The operand fields are
1238
+ table. The operand fields are:
1239
1239
1240
1240
* *ispacked *: Non-zero if the type represents a packed structure
1241
1241
@@ -1258,7 +1258,7 @@ TYPE_CODE_STRUCT_NAMED Record
1258
1258
1259
1259
The ``STRUCT_NAMED `` record (code 20) adds an identified struct type to the
1260
1260
type table, with a name defined by a previously encountered ``STRUCT_NAME ``
1261
- record. The operand fields are
1261
+ record. The operand fields are:
1262
1262
1263
1263
* *ispacked *: Non-zero if the type represents a packed structure
1264
1264
@@ -1271,7 +1271,7 @@ TYPE_CODE_FUNCTION Record
1271
1271
``[FUNCTION, vararg, retty, ...paramty... ] ``
1272
1272
1273
1273
The ``FUNCTION `` record (code 21) adds a function type to the type table. The
1274
- operand fields are
1274
+ operand fields are:
1275
1275
1276
1276
* *vararg *: Non-zero if the type represents a varargs function
1277
1277
@@ -1294,7 +1294,7 @@ TYPE_CODE_TARGET_TYPE Record
1294
1294
1295
1295
The ``TARGET_TYPE `` record (code 26) adds a target extension type to the type
1296
1296
table, with a name defined by a previously encountered ``STRUCT_NAME `` record.
1297
- The operand fields are
1297
+ The operand fields are:
1298
1298
1299
1299
* *num_tys *: The number of parameters that are types (as opposed to integers)
1300
1300
0 commit comments