Skip to content

Commit 7d832f3

Browse files
committed
[TI removal] Remove discussion of TerminatorInst from the LLVM
documentation. llvm-svn: 344727
1 parent 11add31 commit 7d832f3

File tree

2 files changed

+6
-13
lines changed

2 files changed

+6
-13
lines changed

llvm/docs/BranchWeightMetadata.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,10 @@ Introduction
99
============
1010

1111
Branch Weight Metadata represents branch weights as its likeliness to be taken
12-
(see :doc:`BlockFrequencyTerminology`). Metadata is assigned to the
13-
``TerminatorInst`` as a ``MDNode`` of the ``MD_prof`` kind. The first operator
14-
is always a ``MDString`` node with the string "branch_weights". Number of
15-
operators depends on the terminator type.
12+
(see :doc:`BlockFrequencyTerminology`). Metadata is assigned to an
13+
``Instruction`` that is a terminator as a ``MDNode`` of the ``MD_prof`` kind.
14+
The first operator is always a ``MDString`` node with the string
15+
"branch_weights". Number of operators depends on the terminator type.
1616

1717
Branch weights might be fetch from the profiling file, or generated based on
1818
`__builtin_expect`_ instruction.

llvm/docs/ProgrammersManual.rst

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3736,13 +3736,6 @@ Important Subclasses of the ``Instruction`` class
37363736
`ICmpInst <LangRef.html#i_icmp>`_ (integer opreands), and
37373737
`FCmpInst <LangRef.html#i_fcmp>`_ (floating point operands).
37383738

3739-
.. _TerminatorInst:
3740-
3741-
* ``TerminatorInst``
3742-
3743-
This subclass is the parent of all terminator instructions (those which can
3744-
terminate a block).
3745-
37463739
.. _m_Instruction:
37473740

37483741
Important Public Members of the ``Instruction`` class
@@ -4068,7 +4061,7 @@ This class represents a single entry single exit section of the code, commonly
40684061
known as a basic block by the compiler community. The ``BasicBlock`` class
40694062
maintains a list of Instruction_\ s, which form the body of the block. Matching
40704063
the language definition, the last element of this list of instructions is always
4071-
a terminator instruction (a subclass of the TerminatorInst_ class).
4064+
a terminator instruction.
40724065

40734066
In addition to tracking the list of instructions that make up the block, the
40744067
``BasicBlock`` class also keeps track of the :ref:`Function <c_Function>` that
@@ -4119,7 +4112,7 @@ Important Public Members of the ``BasicBlock`` class
41194112
Returns a pointer to :ref:`Function <c_Function>` the block is embedded into,
41204113
or a null pointer if it is homeless.
41214114

4122-
* ``TerminatorInst *getTerminator()``
4115+
* ``Instruction *getTerminator()``
41234116

41244117
Returns a pointer to the terminator instruction that appears at the end of the
41254118
``BasicBlock``. If there is no terminator instruction, or if the last

0 commit comments

Comments
 (0)