Skip to content

Commit 0aca734

Browse files
[llvm] Proofread BitCodeFormat.rst (llvm#157024)
1 parent c11d808 commit 0aca734

File tree

1 file changed

+19
-19
lines changed

1 file changed

+19
-19
lines changed

llvm/docs/BitCodeFormat.rst

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -87,9 +87,9 @@ Fixed Width Integers
8787
^^^^^^^^^^^^^^^^^^^^
8888

8989
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
9191
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.
9393

9494
.. _Variable Width Integers:
9595
.. _Variable Width Integer:
@@ -229,7 +229,7 @@ Data Records
229229
------------
230230

231231
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
233233
may vary between different block types. Records can be encoded either using an
234234
unabbrev record, or with an abbreviation. In the LLVM IR format, for example,
235235
there is a record which encodes the target triple of a module. The code is
@@ -469,19 +469,19 @@ Native Object File Wrapper Format
469469
=================================
470470

471471
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
474474
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
476476
that has gone through a pre-link LTO pipeline). The ``.llvmbc`` section
477477
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
479479
for accommodating LTO in compilation pipelines where intermediate objects must
480480
be native object files which contain metadata in other sections.
481481

482482
Not all tools support this format. For example, lld and the gold plugin will
483483
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.
485485

486486
.. _encoding of LLVM IR:
487487

@@ -585,7 +585,7 @@ MODULE_CODE_VERSION Record
585585
``[VERSION, version#]``
586586

587587
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
589589
version 0 and 1 is in the encoding of instruction operands in
590590
each `FUNCTION_BLOCK`_.
591591

@@ -1033,13 +1033,13 @@ in the file `Attributes.td
10331033
.. note::
10341034
The ``allocsize`` attribute has a special encoding for its arguments. Its two
10351035
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
10371037
the sentinel value -1 if it is not specified.
10381038

10391039
.. note::
10401040
The ``vscale_range`` attribute has a special encoding for its arguments. Its two
10411041
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
10431043
it is not specified.
10441044

10451045
.. _TYPE_BLOCK:
@@ -1137,7 +1137,7 @@ TYPE_CODE_POINTER Record
11371137
``[POINTER, pointee type, address space]``
11381138

11391139
The ``POINTER`` record (code 8) adds a pointer type to the type table. The
1140-
operand fields are
1140+
operand fields are:
11411141

11421142
* *pointee type*: The type index of the pointed-to type
11431143

@@ -1155,7 +1155,7 @@ TYPE_CODE_FUNCTION_OLD Record
11551155
``[FUNCTION_OLD, vararg, ignored, retty, ...paramty... ]``
11561156

11571157
The ``FUNCTION_OLD`` record (code 9) adds a function type to the type table.
1158-
The operand fields are
1158+
The operand fields are:
11591159

11601160
* *vararg*: Non-zero if the type represents a varargs function
11611161

@@ -1173,7 +1173,7 @@ TYPE_CODE_ARRAY Record
11731173
``[ARRAY, numelts, eltty]``
11741174

11751175
The ``ARRAY`` record (code 11) adds an array type to the type table. The
1176-
operand fields are
1176+
operand fields are:
11771177

11781178
* *numelts*: The number of elements in arrays of this type
11791179

@@ -1185,7 +1185,7 @@ TYPE_CODE_VECTOR Record
11851185
``[VECTOR, numelts, eltty]``
11861186

11871187
The ``VECTOR`` record (code 12) adds a vector type to the type table. The
1188-
operand fields are
1188+
operand fields are:
11891189

11901190
* *numelts*: The number of elements in vectors of this type
11911191

@@ -1235,7 +1235,7 @@ TYPE_CODE_STRUCT_ANON Record
12351235
``[STRUCT_ANON, ispacked, ...eltty...]``
12361236

12371237
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:
12391239

12401240
* *ispacked*: Non-zero if the type represents a packed structure
12411241

@@ -1258,7 +1258,7 @@ TYPE_CODE_STRUCT_NAMED Record
12581258

12591259
The ``STRUCT_NAMED`` record (code 20) adds an identified struct type to the
12601260
type table, with a name defined by a previously encountered ``STRUCT_NAME``
1261-
record. The operand fields are
1261+
record. The operand fields are:
12621262

12631263
* *ispacked*: Non-zero if the type represents a packed structure
12641264

@@ -1271,7 +1271,7 @@ TYPE_CODE_FUNCTION Record
12711271
``[FUNCTION, vararg, retty, ...paramty... ]``
12721272

12731273
The ``FUNCTION`` record (code 21) adds a function type to the type table. The
1274-
operand fields are
1274+
operand fields are:
12751275

12761276
* *vararg*: Non-zero if the type represents a varargs function
12771277

@@ -1294,7 +1294,7 @@ TYPE_CODE_TARGET_TYPE Record
12941294

12951295
The ``TARGET_TYPE`` record (code 26) adds a target extension type to the type
12961296
table, with a name defined by a previously encountered ``STRUCT_NAME`` record.
1297-
The operand fields are
1297+
The operand fields are:
12981298

12991299
* *num_tys*: The number of parameters that are types (as opposed to integers)
13001300

0 commit comments

Comments
 (0)