Skip to content

[llvm] Proofread *.rst #151087

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions llvm/docs/AMDGPUDwarfExtensionsForHeterogeneousDebugging.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1187,7 +1187,7 @@ There are five kinds of location storage:
operations. It would specify the debugger information entry and byte offset
provided by the operations.

*Location descriptions are a language independent representation of addressing
*Location descriptions are a language-independent representation of addressing
rules.*

* *They can be the result of evaluating a debugger information entry attribute
Expand Down Expand Up @@ -1523,8 +1523,8 @@ expression.
states that relocation of references from one executable or shared object
file to another must be performed by the consumer. But given that DR is
defined as an offset in a ``.debug_info`` section this seems impossible.
If DR was defined as an implementation defined value, then the consumer
could choose to interpret the value in an implementation defined manner to
If DR was defined as an implementation-defined value, then the consumer
could choose to interpret the value in an implementation-defined manner to
reference a debug information in another executable or shared object.

In ELF the ``.debug_info`` section is in a non-\ ``PT_LOAD`` segment so
Expand Down Expand Up @@ -4188,7 +4188,7 @@ The register rules are:
conversion as the bit contents of the register is simply interpreted as a
value of the address.

GDB has a per register hook that allows a target specific conversion on a
GDB has a per register hook that allows a target-specific conversion on a
register by register basis. It defaults to truncation of bigger registers,
and to actually reading bytes from the next register (or reads out of bounds
for the last register) for smaller registers. There are no GDB tests that
Expand Down
2 changes: 1 addition & 1 deletion llvm/docs/AMDGPUUsage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1887,7 +1887,7 @@ The AMDGPU backend supports the following calling conventions:
AMDGPU MCExpr
-------------

As part of the AMDGPU MC layer, AMDGPU provides the following target specific
As part of the AMDGPU MC layer, AMDGPU provides the following target-specific
``MCExpr``\s.

.. table:: AMDGPU MCExpr types:
Expand Down
6 changes: 3 additions & 3 deletions llvm/docs/CodeGenerator.rst
Original file line number Diff line number Diff line change
Expand Up @@ -323,7 +323,7 @@ provide one of these objects through the ``getJITInfo`` method.
Machine code description classes
================================

At the high-level, LLVM code is translated to a machine specific representation
At the high-level, LLVM code is translated to a machine-specific representation
formed out of :raw-html:`<tt>` `MachineFunction`_ :raw-html:`</tt>`,
:raw-html:`<tt>` `MachineBasicBlock`_ :raw-html:`</tt>`, and :raw-html:`<tt>`
`MachineInstr`_ :raw-html:`</tt>` instances (defined in
Expand Down Expand Up @@ -462,7 +462,7 @@ code:
ret

This approach is extremely general (if it can handle the X86 architecture, it
can handle anything!) and allows all of the target specific knowledge about the
can handle anything!) and allows all of the target-specific knowledge about the
instruction stream to be isolated in the instruction selector. Note that
physical registers should have a short lifetime for good code generation, and
all physical registers are assumed dead on entry to and exit from basic blocks
Expand Down Expand Up @@ -634,7 +634,7 @@ file (MCObjectStreamer). MCAsmStreamer is a straightforward implementation
that prints out a directive for each method (e.g. ``EmitValue -> .byte``), but
MCObjectStreamer implements a full assembler.

For target specific directives, the MCStreamer has a MCTargetStreamer instance.
For target-specific directives, the MCStreamer has a MCTargetStreamer instance.
Each target that needs it defines a class that inherits from it and is a lot
like MCStreamer itself: It has one method per directive and two classes that
inherit from it, a target object streamer and a target asm streamer. The target
Expand Down
4 changes: 2 additions & 2 deletions llvm/docs/CommandGuide/llvm-bcanalyzer.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ DESCRIPTION
The :program:`llvm-bcanalyzer` command is a small utility for analyzing bitcode
files. The tool reads a bitcode file (such as generated with the
:program:`llvm-as` tool) and produces a statistical report on the contents of
the bitcode file. The tool can also dump a low level but human readable
the bitcode file. The tool can also dump a low level but human-readable
version of the bitcode file. This tool is probably not of much interest or
utility except for those working directly with the bitcode file format. Most
LLVM users can just ignore this tool.
Expand All @@ -30,7 +30,7 @@ OPTIONS

.. option:: --dump

Causes :program:`llvm-bcanalyzer` to dump the bitcode in a human readable
Causes :program:`llvm-bcanalyzer` to dump the bitcode in a human-readable
format. This format is significantly different from LLVM assembly and
provides details about the encoding of the bitcode file.

Expand Down
2 changes: 1 addition & 1 deletion llvm/docs/CommandGuide/llvm-debuginfo-analyzer.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ DESCRIPTION
-----------
:program:`llvm-debuginfo-analyzer` parses debug and text sections in
binary object files and prints their contents in a logical view, which
is a human readable representation that closely matches the structure
is a human-readable representation that closely matches the structure
of the original user source code. Supported object file formats include
ELF, Mach-O, WebAssembly, PDB and COFF.

Expand Down
2 changes: 1 addition & 1 deletion llvm/docs/CommandGuide/llvm-exegesis.rst
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ properly.
using the loop repetition mode. :program:`llvm-exegesis` needs to keep track
of the current loop iteration within the loop repetition mode in a performant
manner (i.e., no memory accesses), and uses a register to do this. This register
has an architecture specific default (e.g., `R8` on X86), but this might conflict
has an architecture-specific default (e.g., `R8` on X86), but this might conflict
with some snippets. This annotation allows changing the register to prevent
interference between the loop index register and the snippet.

Expand Down
2 changes: 1 addition & 1 deletion llvm/docs/CommandGuide/llvm-ifs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ SYNOPSIS
DESCRIPTION
-----------

:program:`llvm-ifs` is a tool that jointly produces human readable text-based
:program:`llvm-ifs` is a tool that jointly produces human-readable text-based
stubs (.ifs files) for shared objects and linkable shared object stubs
(.so files) from either ELF shared objects or text-based stubs. The text-based
stubs is useful for monitoring ABI changes of the shared object. The linkable
Expand Down
2 changes: 1 addition & 1 deletion llvm/docs/CommandGuide/llvm-locstats.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ DESCRIPTION

:program:`llvm-locstats` works like a wrapper around :program:`llvm-dwarfdump`.
It parses :program:`llvm-dwarfdump` statistics regarding debug location by
pretty printing it in a more human readable way.
pretty printing it in a more human-readable way.

The line 0% shows the number and the percentage of DIEs with no location
information, but the line 100% shows the information for DIEs where there is
Expand Down
12 changes: 6 additions & 6 deletions llvm/docs/CommandGuide/llvm-mca.rst
Original file line number Diff line number Diff line change
Expand Up @@ -241,7 +241,7 @@ option specifies "``-``", then the output will also be sent to standard output.
.. option:: -disable-cb

Force usage of the generic CustomBehaviour and InstrPostProcess classes rather
than using the target specific implementation. The generic classes never
than using the target-specific implementation. The generic classes never
detect any custom hazards or make any post processing modifications to
instructions.

Expand Down Expand Up @@ -1125,9 +1125,9 @@ CustomBehaviour class can be used in these cases to enforce proper
instruction modeling (often by customizing data dependencies and detecting
hazards that :program:`llvm-mca` has no way of knowing about).

:program:`llvm-mca` comes with one generic and multiple target specific
:program:`llvm-mca` comes with one generic and multiple target-specific
CustomBehaviour classes. The generic class will be used if the ``-disable-cb``
flag is used or if a target specific CustomBehaviour class doesn't exist for
flag is used or if a target-specific CustomBehaviour class doesn't exist for
that target. (The generic class does nothing.) Currently, the CustomBehaviour
class is only a part of the in-order pipeline, but there are plans to add it
to the out-of-order pipeline in the future.
Expand All @@ -1141,7 +1141,7 @@ if you don't know the exact number and a value of 0 represents no stall).

If you'd like to add a CustomBehaviour class for a target that doesn't
already have one, refer to an existing implementation to see how to set it
up. The classes are implemented within the target specific backend (for
up. The classes are implemented within the target-specific backend (for
example `/llvm/lib/Target/AMDGPU/MCA/`) so that they can access backend symbols.

Instrument Manager
Expand Down Expand Up @@ -1177,12 +1177,12 @@ classes (MCSubtargetInfo, MCInstrInfo, etc.), please add it to the
AND requires unexposed backend symbols or functionality, you can define it in
the `/lib/Target/<TargetName>/MCA/` directory.

To enable this target specific View, you will have to use this target's
To enable this target-specific View, you will have to use this target's
CustomBehaviour class to override the `CustomBehaviour::getViews()` methods.
There are 3 variations of these methods based on where you want your View to
appear in the output: `getStartViews()`, `getPostInstrInfoViews()`, and
`getEndViews()`. These methods returns a vector of Views so you will want to
return a vector containing all of the target specific Views for the target in
return a vector containing all of the target-specific Views for the target in
question.

Because these target specific (and backend dependent) Views require the
Expand Down
2 changes: 1 addition & 1 deletion llvm/docs/CommandGuide/llvm-profdata.rst
Original file line number Diff line number Diff line change
Expand Up @@ -338,7 +338,7 @@ OPTIONS

Instruct the profile dumper to show profile counts in the text format of the
instrumentation-based profile data representation. By default, the profile
information is dumped in a more human readable form (also in text) with
information is dumped in a more human-readable form (also in text) with
annotations.

.. option:: --topn=<n>
Expand Down
4 changes: 2 additions & 2 deletions llvm/docs/CommandGuide/llvm-symbolizer.rst
Original file line number Diff line number Diff line change
Expand Up @@ -371,7 +371,7 @@ OPTIONS
* Prints an address's debug-data discriminator when it is non-zero. One way to
produce discriminators is to compile with clang's -fdebug-info-for-profiling.

``JSON`` style provides a machine readable output in JSON. If addresses are
``JSON`` style provides a machine-readable output in JSON. If addresses are
supplied via stdin, the output JSON will be a series of individual objects.
Otherwise, all results will be contained in a single array.

Expand Down Expand Up @@ -444,7 +444,7 @@ OPTIONS

.. option:: --pretty-print, -p

Print human readable output. If :option:`--inlining` is specified, the
Print human-readable output. If :option:`--inlining` is specified, the
enclosing scope is prefixed by (inlined by).
For JSON output, the option will cause JSON to be indented and split over
new lines. Otherwise, the JSON output will be printed in a compact form.
Expand Down
2 changes: 1 addition & 1 deletion llvm/docs/DirectX/DXContainer.rst
Original file line number Diff line number Diff line change
Expand Up @@ -280,7 +280,7 @@ elements are:
This represents ``f5`` in the source.

The LLVM ``obj2yaml`` tool can parse this data out of the PSV and present it in
human readable YAML. For the example above it produces the output:
human-readable YAML. For the example above it produces the output:

.. code-block:: YAML

Expand Down
2 changes: 1 addition & 1 deletion llvm/docs/Frontend/PerformanceTips.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ The Basics
^^^^^^^^^^^

#. Make sure that your Modules contain both a data layout specification and
target triple. Without these pieces, non of the target specific optimization
target triple. Without these pieces, non of the target-specific optimization
will be enabled. This can have a major effect on the generated code quality.

#. For each function or global emitted, use the most private linkage type
Expand Down
2 changes: 1 addition & 1 deletion llvm/docs/FuzzingLLVM.rst
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ llvm-mc-assemble-fuzzer
-----------------------

A |generic fuzzer| that fuzzes the MC layer's assemblers by treating inputs as
target specific assembly.
target-specific assembly.

Note that this fuzzer has an unusual command line interface which is not fully
compatible with all of libFuzzer's features. Fuzzer arguments must be passed
Expand Down
4 changes: 2 additions & 2 deletions llvm/docs/GettingStarted.rst
Original file line number Diff line number Diff line change
Expand Up @@ -919,11 +919,11 @@ the `Command Guide <CommandGuide/index.html>`_.

``llvm-as``

The assembler transforms the human readable LLVM assembly to LLVM bitcode.
The assembler transforms the human-readable LLVM assembly to LLVM bitcode.

``llvm-dis``

The disassembler transforms the LLVM bitcode to human readable LLVM assembly.
The disassembler transforms the LLVM bitcode to human-readable LLVM assembly.

``llvm-link``

Expand Down
2 changes: 1 addition & 1 deletion llvm/docs/GlobalISel/GMIR.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Generic Machine Instructions
Reference.

Whereas MIR deals largely in Target Instructions and only has a small set of
target independent opcodes such as ``COPY``, ``PHI``, and ``REG_SEQUENCE``,
target-independent opcodes such as ``COPY``, ``PHI``, and ``REG_SEQUENCE``,
gMIR defines a rich collection of ``Generic Opcodes`` which are target
independent and describe operations which are typically supported by targets.
One example is ``G_ADD`` which is the generic opcode for an integer addition.
Expand Down
2 changes: 1 addition & 1 deletion llvm/docs/GlobalISel/GenericOpcode.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1105,7 +1105,7 @@ G_TRAP, G_DEBUGTRAP, G_UBSANTRAP
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Represents :ref:`llvm.trap <llvm.trap>`, :ref:`llvm.debugtrap <llvm.debugtrap>`
and :ref:`llvm.ubsantrap <llvm.ubsantrap>` that generate a target dependent
and :ref:`llvm.ubsantrap <llvm.ubsantrap>` that generate a target-dependent
trap instructions.

.. code-block:: none
Expand Down
2 changes: 1 addition & 1 deletion llvm/docs/GlobalISel/Pipeline.rst
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ Combiner
alternatives but Combiners can also focus on code size or other metrics.

Additional passes such as these can be inserted to support higher optimization
levels or target specific needs. A likely pipeline is:
levels or target-specific needs. A likely pipeline is:

.. image:: pipeline-overview-with-combiners.png

Expand Down
2 changes: 1 addition & 1 deletion llvm/docs/HowToUpdateDebugInfo.rst
Original file line number Diff line number Diff line change
Expand Up @@ -499,7 +499,7 @@ a JSON file as follows:
$ opt -verify-debuginfo-preserve -verify-di-preserve-export=sample.json -pass-to-test sample.ll

and then use the ``llvm/utils/llvm-original-di-preservation.py`` script
to generate an HTML page with the issues reported in a more human readable form
to generate an HTML page with the issues reported in a more human-readable form
as follows:

.. code-block:: bash
Expand Down
2 changes: 1 addition & 1 deletion llvm/docs/JITLink.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1072,7 +1072,7 @@ Major outstanding projects include:

* Refactor architecture support to maximize sharing across formats.

All formats should be able to share the bulk of the architecture specific
All formats should be able to share the bulk of the architecture-specific
code (especially relocations) for each supported architecture.

* Refactor ELF link graph construction.
Expand Down
6 changes: 3 additions & 3 deletions llvm/docs/LangRef.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ readable assembly language representation. This allows LLVM to provide a
powerful intermediate representation for efficient compiler
transformations and analysis, while providing a natural means to debug
and visualize the transformations. The three different forms of LLVM are
all equivalent. This document describes the human readable
all equivalent. This document describes the human-readable
representation and notation.

The LLVM representation aims to be light-weight and low-level while
Expand Down Expand Up @@ -21287,7 +21287,7 @@ Semantics:
On some architectures the address of the code to be executed needs to be
different than the address where the trampoline is actually stored. This
intrinsic returns the executable address corresponding to ``tramp``
after performing the required machine specific adjustments. The pointer
after performing the required machine-specific adjustments. The pointer
returned can then be :ref:`bitcast and executed <int_trampoline>`.


Expand Down Expand Up @@ -29378,7 +29378,7 @@ None.
Semantics:
""""""""""

This intrinsic is lowered to the target dependent trap instruction. If
This intrinsic is lowered to the target-dependent trap instruction. If
the target does not have a trap instruction, this intrinsic will be
lowered to a call of the ``abort()`` function.

Expand Down
2 changes: 1 addition & 1 deletion llvm/docs/Lexicon.rst
Original file line number Diff line number Diff line change
Expand Up @@ -192,7 +192,7 @@ L
**LSDA**
Language Specific Data Area. C++ "zero cost" unwinding is built on top a
generic unwinding mechanism. As the unwinder walks each frame, it calls
a "personality" function to do language specific analysis. Each function's
a "personality" function to do language-specific analysis. Each function's
FDE points to an optional LSDA which is passed to the personality function.
For C++, the LSDA contain info about the type and location of catch
statements in that function.
Expand Down
4 changes: 2 additions & 2 deletions llvm/docs/MIRLangRef.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Introduction
============

This document is a reference manual for the Machine IR (MIR) serialization
format. MIR is a human readable serialization format that is used to represent
format. MIR is a human-readable serialization format that is used to represent
LLVM's :ref:`machine specific intermediate representation
<machine code representation>`.

Expand Down Expand Up @@ -221,7 +221,7 @@ Machine Instructions Format Reference
=====================================

The machine basic blocks and their instructions are represented using a custom,
human readable serialization language. This language is used in the
human-readable serialization language. This language is used in the
`YAML block literal string`_ that corresponds to the machine function's body.

A source string that uses this language contains a list of machine basic
Expand Down
2 changes: 1 addition & 1 deletion llvm/docs/PDB/CodeViewTypes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ The ``Size`` field of the Attributes bitmask is a 1-byte value indicating the
pointer size. For example, a `void*` would have a size of either 4 or 8 depending
on the target architecture. On the other hand, if ``Mode`` indicates that this is
a pointer to member function or pointer to data member, then the size can be any
implementation defined number.
implementation-defined number.

The ``Member Ptr Info`` field of the ``LF_POINTER`` record is only present if the
attributes indicate that this is a pointer to member.
Expand Down
2 changes: 1 addition & 1 deletion llvm/docs/SymbolizerMarkupFormat.rst
Original file line number Diff line number Diff line change
Expand Up @@ -315,7 +315,7 @@ Trigger elements
================

These elements cause an external action and will be presented to the user in a
human readable form. Generally they trigger an external action to occur that
human-readable form. Generally they trigger an external action to occur that
results in a linkable page. The link or some other informative information about
the external action can then be presented to the user.

Expand Down
4 changes: 2 additions & 2 deletions llvm/docs/WritingAnLLVMBackend.rst
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,7 @@ any other naming scheme will confuse ``llvm-config`` and produce a lot of
To make your target actually do something, you need to implement a subclass of
``TargetMachine``. This implementation should typically be in the file
``lib/Target/DummyTargetMachine.cpp``, but any file in the ``lib/Target``
directory will be built and should work. To use LLVM's target independent code
directory will be built and should work. To use LLVM's target-independent code
generator, you should do what all current machine backends do: create a
subclass of ``CodeGenTargetMachineImpl``. (To create a target from scratch, create a
subclass of ``TargetMachine``.)
Expand Down Expand Up @@ -1671,7 +1671,7 @@ For example in ``SparcTargetAsmInfo.cpp``:
}

The X86 assembly printer implementation (``X86TargetAsmInfo``) is an example
where the target specific ``TargetAsmInfo`` class uses an overridden methods:
where the target-specific ``TargetAsmInfo`` class uses an overridden methods:
``ExpandInlineAsm``.

A target-specific implementation of ``AsmPrinter`` is written in
Expand Down
2 changes: 1 addition & 1 deletion llvm/docs/WritingAnLLVMPass.rst
Original file line number Diff line number Diff line change
Expand Up @@ -431,7 +431,7 @@ The ``print`` method
virtual void print(llvm::raw_ostream &O, const Module *M) const;

The ``print`` method must be implemented by "analyses" in order to print a
human readable version of the analysis results. This is useful for debugging
human-readable version of the analysis results. This is useful for debugging
an analysis itself, as well as for other people to figure out how an analysis
works. Use the opt ``-analyze`` argument to invoke this method.

Expand Down
2 changes: 1 addition & 1 deletion llvm/docs/tutorial/MyFirstLanguageFrontend/LangImpl10.rst
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ course, C source code is not actually portable in general either - ever
port a really old application from 32- to 64-bits?).

The problem with C (again, in its full generality) is that it is heavily
laden with target specific assumptions. As one simple example, the
laden with target-specific assumptions. As one simple example, the
preprocessor often destructively removes target-independence from the
code when it processes the input text:

Expand Down
Loading