Skip to content

Commit abdef44

Browse files
[clang] Proofread ClangOffloadBundler.rst (#165136)
1 parent a7b1889 commit abdef44

File tree

1 file changed

+19
-19
lines changed

1 file changed

+19
-19
lines changed

clang/docs/ClangOffloadBundler.rst

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ A bundled code object may also be used to bundle just the offloaded code
2828
objects, and embedded as data into the host code object. The host compilation
2929
includes an ``init`` function that will use the runtime corresponding to the
3030
offload kind (see :ref:`clang-offload-kind-table`) to load the offload code
31-
objects appropriate to the devices present when the host program is executed.
31+
objects appropriate for the devices present when the host program is executed.
3232

3333
:program:`clang-offload-bundler` is located in
3434
`clang/tools/clang-offload-bundler`.
@@ -147,21 +147,21 @@ bundle file is:
147147
<end> ::== OFFLOAD_BUNDLER_MAGIC_STR__END__
148148

149149
**comment**
150-
The symbol used for starting single-line comment in the file type of
150+
The symbol used for starting a single-line comment in the file type of
151151
constituting bundles. E.g. it is ";" for ll ``File Type`` and "#" for "s"
152152
``File Type``.
153153

154154
**bundle_id**
155155
The :ref:`clang-bundle-entry-id` for the enclosing bundle.
156156

157157
**eol**
158-
The end of line character.
158+
The end-of-line character.
159159

160160
**bundle**
161161
The code object stored in one of the supported text file formats.
162162

163163
**OFFLOAD_BUNDLER_MAGIC_STR__**
164-
Magic string that marks the existence of offloading data i.e.
164+
The magic string that marks the existence of offloading data i.e.
165165
"__CLANG_OFFLOAD_BUNDLE__".
166166

167167
.. _clang-bundled-code-object-layout:
@@ -231,7 +231,7 @@ Where:
231231
============= ==============================================================
232232
host Host code object. ``clang-offload-bundler`` always includes
233233
this entry as the first bundled code object entry. For an
234-
embedded bundled code object this entry is not used by the
234+
embedded bundled code object, this entry is not used by the
235235
runtime and so is generally an empty code object.
236236

237237
hip Offload code object for the HIP language. Used for all
@@ -272,7 +272,7 @@ without differentiation based on offload kind.
272272
``<arch><sub>-<vendor>-<sys>-<env>``
273273

274274
However, in order to standardize outputs for tools that consume bitcode bundles
275-
and to parse target ID containing dashes, the bundler only accepts target
275+
and to parse a target ID containing dashes, the bundler only accepts target
276276
triples in the 4-field format:
277277

278278
``<arch><sub>-<vendor>-<sys>-<env>``
@@ -292,17 +292,17 @@ Bundled Code Object Composition
292292
* If there is an entry with a target feature specified as *Any*, then all
293293
entries must specify that target feature as *Any* for the same processor.
294294

295-
There may be additional target specific restrictions.
295+
There may be additional target-specific restrictions.
296296

297297
.. _compatibility-bundle-entry-id:
298298

299299
Compatibility Rules for Bundle Entry ID
300300
---------------------------------------
301301

302302
A code object, specified using its Bundle Entry ID, can be loaded and
303-
executed on a target processor, if:
303+
executed on a target processor if:
304304

305-
* Their offload kinds are the same or comptible.
305+
* Their offload kinds are the same or compatible.
306306
* Their target triples are compatible.
307307
* Their Target IDs are compatible as defined in :ref:`compatibility-target-id`.
308308

@@ -331,7 +331,7 @@ Target ID syntax is defined by the following BNF syntax:
331331
Where:
332332

333333
**processor**
334-
Is a the target specific processor or any alternative processor name.
334+
Is the target-specific processor or any alternative processor name.
335335

336336
**target-feature**
337337
Is a target feature name that is supported by the processor. Each target
@@ -350,7 +350,7 @@ Where:
350350
can only be loaded on a processor configured with the target feature on.
351351

352352
*Off*
353-
specified by ``-``, indicating the target feature is disabled. A code
353+
Specified by ``-``, indicating the target feature is disabled. A code
354354
object compiled with a target ID specifying a target feature off
355355
can only be loaded on a processor configured with the target feature off.
356356

@@ -360,9 +360,9 @@ Compatibility Rules for Target ID
360360
---------------------------------
361361

362362
A code object compiled for a Target ID is considered compatible for a
363-
target, if:
363+
target if:
364364

365-
* Their processor is same.
365+
* Their processor is the same.
366366
* Their feature set is compatible as defined above.
367367

368368
There are two forms of target ID:
@@ -380,10 +380,10 @@ There are two forms of target ID:
380380
alphabetic order. Command line tools convert non-canonical form to canonical
381381
form.
382382

383-
Target Specific information
383+
Target-Specific information
384384
===========================
385385

386-
Target specific information is available for the following:
386+
Target-specific information is available for the following:
387387

388388
*AMD GPU*
389389
AMD GPU supports target ID and target features. See `User Guide for AMDGPU Backend
@@ -397,7 +397,7 @@ Most other targets do not support target IDs.
397397
Archive Unbundling
398398
==================
399399

400-
Unbundling of a heterogeneous device archive (HDA) is done to create device specific
400+
Unbundling of a heterogeneous device archive (HDA) is done to create device-specific
401401
archives. HDA is in a format compatible with GNU ``ar`` utility and contains a
402402
collection of bundled device binaries where each bundle file will contain
403403
device binaries for a host and one or more targets. The output device-specific
@@ -469,7 +469,7 @@ compatible with that particular offload target. Compatibility between a
469469
device binary in HDA and a target is based on the compatibility between their
470470
bundle entry IDs as defined in :ref:`compatibility-bundle-entry-id`.
471471

472-
Following cases may arise during compatibility testing:
472+
The following cases may arise during compatibility testing:
473473

474474
* A binary is compatible with one or more targets: Insert the binary into the
475475
device-specific archive of each compatible target.
@@ -517,7 +517,7 @@ Compression and Decompression
517517

518518
``clang-offload-bundler`` provides features to compress and decompress the full
519519
bundle, leveraging inherent redundancies within the bundle entries. Use the
520-
`-compress` command-line option to enable this compression capability.
520+
``-compress`` command-line option to enable this compression capability.
521521

522522
The compressed offload bundle begins with a header followed by the compressed binary data:
523523

@@ -542,4 +542,4 @@ The compressed offload bundle begins with a header followed by the compressed bi
542542
- **Compressed Data**:
543543
The actual compressed binary data follows the header. Its size can be inferred from the total size of the file minus the header size.
544544

545-
> **Note**: Version 3 is now the default format. For backward compatibility with older HIP runtimes that support version 2 only, set the environment variable `COMPRESSED_BUNDLE_FORMAT_VERSION=2`.
545+
> **Note**: Version 3 is now the default format. For backward compatibility with older HIP runtimes that support version 2 only, set the environment variable ``COMPRESSED_BUNDLE_FORMAT_VERSION=2``.

0 commit comments

Comments
 (0)