[llvm] r344727 - [TI removal] Remove discussion of `TerminatorInst` from the LLVM
Chandler Carruth via llvm-commits
llvm-commits at lists.llvm.org
Thu Oct 18 00:40:24 PDT 2018
Author: chandlerc
Date: Thu Oct 18 00:40:24 2018
New Revision: 344727
URL: http://llvm.org/viewvc/llvm-project?rev=344727&view=rev
Log:
[TI removal] Remove discussion of `TerminatorInst` from the LLVM
documentation.
Modified:
llvm/trunk/docs/BranchWeightMetadata.rst
llvm/trunk/docs/ProgrammersManual.rst
Modified: llvm/trunk/docs/BranchWeightMetadata.rst
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/BranchWeightMetadata.rst?rev=344727&r1=344726&r2=344727&view=diff
==============================================================================
--- llvm/trunk/docs/BranchWeightMetadata.rst (original)
+++ llvm/trunk/docs/BranchWeightMetadata.rst Thu Oct 18 00:40:24 2018
@@ -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.
Modified: llvm/trunk/docs/ProgrammersManual.rst
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/ProgrammersManual.rst?rev=344727&r1=344726&r2=344727&view=diff
==============================================================================
--- llvm/trunk/docs/ProgrammersManual.rst (original)
+++ llvm/trunk/docs/ProgrammersManual.rst Thu Oct 18 00:40:24 2018
@@ -3736,13 +3736,6 @@ Important Subclasses of the ``Instructio
`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 sin
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 ``BasicB
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
More information about the llvm-commits
mailing list