Skip to content

Commit b6674fe

Browse files
[llvm] Proofread Extensions.rst (#158008)
1 parent 2c12308 commit b6674fe

File tree

1 file changed

+17
-17
lines changed

1 file changed

+17
-17
lines changed

llvm/docs/Extensions.rst

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -157,8 +157,8 @@ is usually the associated section's comdat.
157157
1. It must be a COMDAT section.
158158
2. It cannot be another associative COMDAT section.
159159

160-
In the following example the symbol ``sym`` is the comdat symbol of ``.foo``
161-
and ``.bar`` is associated to ``.foo``.
160+
In the following example, the symbol ``sym`` is the comdat symbol of ``.foo``,
161+
and ``.bar`` is associated with ``.foo``.
162162

163163
.. code-block:: gas
164164
@@ -177,9 +177,9 @@ MC supports these flags in the COFF ``.section`` directive:
177177
- ``y``: Not readable
178178
- ``D``: Discardable (``IMAGE_SCN_MEM_DISCARDABLE``)
179179

180-
These flags are all compatible with gas, with the exception of the ``D`` flag,
181-
which gnu as does not support. For gas compatibility, sections with a name
182-
starting with ".debug" are implicitly discardable.
180+
These flags are all compatible with GNU as, with the exception of the ``D`` flag,
181+
which GNU as does not support. For compatibility with GNU as, sections with a name
182+
starting with ``.debug`` are implicitly discardable.
183183

184184

185185
ARM64/COFF-Dependent
@@ -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 ``.section`` directive.
216+
it is possible to add a 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
@@ -228,17 +228,17 @@ For example, the following code creates two sections named ``.text``.
228228
The unique number is not present in the resulting object at all. It is just used
229229
in the assembler to differentiate the sections.
230230

231-
The 'o' flag is mapped to SHF_LINK_ORDER. If it is present, a symbol
232-
must be given that identifies the section to be placed is the
233-
.sh_link.
231+
The 'o' flag is mapped to ``SHF_LINK_ORDER``. If it is present, a symbol
232+
must be given that identifies the section to be placed in the
233+
``.sh_link``.
234234

235235
.. code-block:: gas
236236
237237
.section .foo,"a",@progbits
238238
.Ltmp:
239239
.section .bar,"ao",@progbits,.Ltmp
240240
241-
which is equivalent to just
241+
which is equivalent to:
242242

243243
.. code-block:: gas
244244
@@ -251,7 +251,7 @@ which is equivalent to just
251251
In order to support passing linker options from the frontend to the linker, a
252252
special section of type ``SHT_LLVM_LINKER_OPTIONS`` (usually named
253253
``.linker-options`` though the name is not significant as it is identified by
254-
the type). The contents of this section is a simple pair-wise encoding of
254+
the type). The contents of this section are a simple pair-wise encoding of
255255
directives for consideration by the linker. The strings are encoded as standard
256256
null-terminated UTF-8 strings. They are emitted inline to avoid having the
257257
linker traverse the object file for retrieving the value. The linker is
@@ -262,7 +262,7 @@ The section has type ``SHT_LLVM_LINKER_OPTIONS`` and has the ``SHF_EXCLUDE``
262262
flag to ensure that the section is treated as opaque by linkers which do not
263263
support the feature and will not be emitted into the final linked binary.
264264

265-
This would be equivalent to the follow raw assembly:
265+
This would be equivalent to the following raw assembly:
266266

267267
.. code-block:: gas
268268
@@ -398,7 +398,7 @@ the symbol that belongs to the partition. It may be constructed as follows:
398398

399399
``SHT_LLVM_BB_ADDR_MAP`` Section (basic block address map)
400400
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
401-
This section stores the binary address of basic blocks along with other related
401+
This section stores the binary addresses of basic blocks along with other related
402402
metadata. This information can be used to map binary profiles (like perf
403403
profiles) directly to machine basic blocks.
404404
This section is emitted with ``-basic-block-address-map`` and will contain
@@ -480,7 +480,7 @@ PGO related analysis data can be emitted after each function within the
480480
Supported analyses currently are Function Entry Count, Basic Block Frequencies,
481481
and Branch Probabilities.
482482

483-
Each analysis is enabled or disabled via a bit in the feature byte. Currently
483+
Each analysis is enabled or disabled via a bit in the feature byte. Currently,
484484
those bits are:
485485

486486
#. Function Entry Count - Number of times the function was called as taken
@@ -627,9 +627,9 @@ Syntax:
627627

628628
``.cv_loc`` Directive
629629
^^^^^^^^^^^^^^^^^^^^^
630-
The first number is a file number, must have been previously assigned with a
631-
``.file`` directive, the second number is the line number and optionally the
632-
third number is a column position (zero if not specified). The remaining
630+
The first number is a file number, which must have been previously assigned with a
631+
``.file`` directive. The second number is the line number, and the
632+
optional third number is a column position (zero if not specified). The remaining
633633
optional items are ``.loc`` sub-directives.
634634

635635
Syntax:

0 commit comments

Comments
 (0)