[docs] Update docs since getBasicBlockList() is now private
authorVasileios Porpodas <vporpodas@google.com>
Wed, 14 Dec 2022 23:44:55 +0000 (15:44 -0800)
committerVasileios Porpodas <vporpodas@google.com>
Fri, 16 Dec 2022 05:41:24 +0000 (21:41 -0800)
Differential Revision: https://reviews.llvm.org/D140163

llvm/docs/ProgrammersManual.rst
llvm/docs/tutorial/MyFirstLanguageFrontend/LangImpl05.rst

index 868e685..d1b3744 100644 (file)
@@ -3882,17 +3882,12 @@ Important Public Members of the ``Function``
 
 * | ``Function::iterator`` - Typedef for basic block list iterator
   | ``Function::const_iterator`` - Typedef for const_iterator.
-  | ``begin()``, ``end()``, ``size()``, ``empty()``
+  | ``begin()``, ``end()``, ``size()``, ``empty()``, ``insert()``,
+    ``splice()``, ``erase()``
 
   These are forwarding methods that make it easy to access the contents of a
   ``Function`` object's BasicBlock_ list.
 
-* ``Function::BasicBlockListType &getBasicBlockList()``
-
-  Returns the list of BasicBlock_\ s.  This is necessary to use when you need to
-  update the list or perform a complex action that doesn't have a forwarding
-  method.
-
 * | ``Function::arg_iterator`` - Typedef for the argument list iterator
   | ``Function::const_arg_iterator`` - Typedef for const_iterator.
   | ``arg_begin()``, ``arg_end()``, ``arg_size()``, ``arg_empty()``
index b517844..c5fb35d 100644 (file)
@@ -377,7 +377,7 @@ value for code that will set up the Phi node.
 .. code-block:: c++
 
       // Emit else block.
-      TheFunction->getBasicBlockList().push_back(ElseBB);
+      TheFunction->insert(TheFunction->end(), ElseBB);
       Builder.SetInsertPoint(ElseBB);
 
       Value *ElseV = Else->codegen();
@@ -398,7 +398,7 @@ code:
 .. code-block:: c++
 
       // Emit merge block.
-      TheFunction->getBasicBlockList().push_back(MergeBB);
+      TheFunction->insert(TheFunction->end(), MergeBB);
       Builder.SetInsertPoint(MergeBB);
       PHINode *PN =
         Builder.CreatePHI(Type::getDoubleTy(TheContext), 2, "iftmp");