[llvm] 370266a - [llvm][docs] Fix typos to say subclasses need to override virtual methods but not overload

Venkata Ramanaiah Nalamothu via llvm-commits llvm-commits at lists.llvm.org
Mon Jul 11 09:55:20 PDT 2022


Author: Venkata Ramanaiah Nalamothu
Date: 2022-07-11T22:25:14+05:30
New Revision: 370266aec543235abd6df429bbd3fe012129c7f9

URL: https://github.com/llvm/llvm-project/commit/370266aec543235abd6df429bbd3fe012129c7f9
DIFF: https://github.com/llvm/llvm-project/commit/370266aec543235abd6df429bbd3fe012129c7f9.diff

LOG: [llvm][docs] Fix typos to say subclasses need to override virtual methods but not overload

Reviewed By: aeubanks

Differential Revision: https://reviews.llvm.org/D129484

Added: 
    

Modified: 
    llvm/docs/WritingAnLLVMPass.rst

Removed: 
    


################################################################################
diff  --git a/llvm/docs/WritingAnLLVMPass.rst b/llvm/docs/WritingAnLLVMPass.rst
index 9065a7dcbba1..b644def6cbeb 100644
--- a/llvm/docs/WritingAnLLVMPass.rst
+++ b/llvm/docs/WritingAnLLVMPass.rst
@@ -377,7 +377,7 @@ should only ask for the ``DominatorTree`` for function definitions, not
 declarations.
 
 To write a correct ``ModulePass`` subclass, derive from ``ModulePass`` and
-overload the ``runOnModule`` method with the following signature:
+override the ``runOnModule`` method with the following signature:
 
 The ``runOnModule`` method
 ^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -485,7 +485,7 @@ To be explicit, ``FunctionPass`` subclasses are not allowed to:
 
 Implementing a ``FunctionPass`` is usually straightforward (See the :ref:`Hello
 World <writing-an-llvm-pass-basiccode>` pass for example).
-``FunctionPass``\ es may overload three virtual methods to do their work.  All
+``FunctionPass``\ es may override three virtual methods to do their work.  All
 of these methods should return ``true`` if they modified the program, or
 ``false`` if they didn't.
 
@@ -550,7 +550,7 @@ loops in loop nest order such that outer most loop is processed last.
 
 ``LoopPass`` subclasses are allowed to update loop nest using ``LPPassManager``
 interface.  Implementing a loop pass is usually straightforward.
-``LoopPass``\ es may overload three virtual methods to do their work.  All
+``LoopPass``\ es may override three virtual methods to do their work.  All
 these methods should return ``true`` if they modified the program, or ``false``
 if they didn't.
 
@@ -611,7 +611,7 @@ but executes on each single entry single exit region in the function.
 region is processed last.
 
 ``RegionPass`` subclasses are allowed to update the region tree by using the
-``RGPassManager`` interface.  You may overload three virtual methods of
+``RGPassManager`` interface.  You may override three virtual methods of
 ``RegionPass`` to implement your own region pass.  All these methods should
 return ``true`` if they modified the program, or ``false`` if they did not.
 


        


More information about the llvm-commits mailing list