From d95ef31baaa927fabeff6af2ad64aba897b69f26 Mon Sep 17 00:00:00 2001 From: Chandler Carruth Date: Thu, 18 Oct 2018 07:40:24 +0000 Subject: [PATCH] [TI removal] Remove discussion of `TerminatorInst` from the LLVM documentation. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@344727 91177308-0d34-0410-b5e6-96231b3b80d8 --- docs/BranchWeightMetadata.rst | 8 ++++---- docs/ProgrammersManual.rst | 11 ++--------- 2 files changed, 6 insertions(+), 13 deletions(-) diff --git a/docs/BranchWeightMetadata.rst b/docs/BranchWeightMetadata.rst index 9bd8bd4ae74..e09587179ec 100644 --- a/docs/BranchWeightMetadata.rst +++ b/docs/BranchWeightMetadata.rst @@ -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. diff --git a/docs/ProgrammersManual.rst b/docs/ProgrammersManual.rst index 64b7de5be15..88c56700eb3 100644 --- a/docs/ProgrammersManual.rst +++ b/docs/ProgrammersManual.rst @@ -3736,13 +3736,6 @@ Important Subclasses of the ``Instruction`` class `ICmpInst `_ (integer opreands), and `FCmpInst `_ (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 ` that @@ -4119,7 +4112,7 @@ Important Public Members of the ``BasicBlock`` class Returns a pointer to :ref:`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