RPCS3/llvm-mirror
1
0
Fork 0
mirror of https://github.com/RPCS3/llvm-mirror.git synced 2024-11-22 02:33:06 +01:00
Code Issues Projects Releases Wiki Activity

[TI removal] Remove discussion of TerminatorInst from the LLVM

Browse Source 
documentation.

llvm-svn: 344727
This commit is contained in:
Chandler Carruth 2018-10-18 07:40:24 +00:00
parent d0fc3bc097
commit 802e3095ab
2 changed files with 6 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/BranchWeightMetadata.rst
View File

@ -9,10 +9,10 @@ Introduction
============
Branch Weight Metadata represents branch weights as its likeliness to be taken
(see :doc:`BlockFrequencyTerminology`). Metadata is assigned to the
``TerminatorInst`` as a ``MDNode`` of the ``MD_prof`` kind. The first operator
is always a ``MDString`` node with the string "branch_weights". Number of
operators depends on the terminator type.
(see :doc:`BlockFrequencyTerminology`). Metadata is assigned to an
``Instruction`` that is a terminator as a ``MDNode`` of the ``MD_prof`` kind.
The first operator is always a ``MDString`` node with the string
"branch_weights". Number of operators depends on the terminator type.
Branch weights might be fetch from the profiling file, or generated based on
`__builtin_expect`_ instruction.

11
docs/ProgrammersManual.rst
View File

@ -3736,13 +3736,6 @@ Important Subclasses of the ``Instruction`` class
`ICmpInst <LangRef.html#i_icmp>`_ (integer opreands), and
`FCmpInst <LangRef.html#i_fcmp>`_ (floating point operands).
.. _TerminatorInst:
* ``TerminatorInst``
This subclass is the parent of all terminator instructions (those which can
terminate a block).
.. _m_Instruction:
Important Public Members of the ``Instruction`` class
@ -4068,7 +4061,7 @@ This class represents a single entry single exit section of the code, commonly
known as a basic block by the compiler community. The ``BasicBlock`` class
maintains a list of Instruction_\ s, which form the body of the block. Matching
the language definition, the last element of this list of instructions is always
a terminator instruction (a subclass of the TerminatorInst_ class).
a terminator instruction.
In addition to tracking the list of instructions that make up the block, the
``BasicBlock`` class also keeps track of the :ref:`Function <c_Function>` that
@ -4119,7 +4112,7 @@ Important Public Members of the ``BasicBlock`` class
Returns a pointer to :ref:`Function <c_Function>` the block is embedded into,
or a null pointer if it is homeless.
* ``TerminatorInst *getTerminator()``
* ``Instruction *getTerminator()``
Returns a pointer to the terminator instruction that appears at the end of the
``BasicBlock``. If there is no terminator instruction, or if the last