[llvm] r222222 - docs: Fix a couple of typo-ish errors in WritingAnLLVMPass

Justin Bogner mail at justinbogner.com
Mon Nov 17 21:00:52 PST 2014


Author: bogner
Date: Mon Nov 17 23:00:52 2014
New Revision: 222222

URL: http://llvm.org/viewvc/llvm-project?rev=222222&view=rev
Log:
docs: Fix a couple of typo-ish errors in WritingAnLLVMPass

- Make CallGraphSCCPass's paragraph about doFinalization refer to
  runOnSCC instead of runOnFunction, since that's what it's about.
- Fix a reference in the FunctionPass paragraph.

Modified:
    llvm/trunk/docs/WritingAnLLVMPass.rst

Modified: llvm/trunk/docs/WritingAnLLVMPass.rst
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/WritingAnLLVMPass.rst?rev=222222&r1=222221&r2=222222&view=diff
==============================================================================
--- llvm/trunk/docs/WritingAnLLVMPass.rst (original)
+++ llvm/trunk/docs/WritingAnLLVMPass.rst Mon Nov 17 23:00:52 2014
@@ -434,9 +434,8 @@ The ``doFinalization(CallGraph &)`` meth
   virtual bool doFinalization(CallGraph &CG);
 
 The ``doFinalization`` method is an infrequently used method that is called
-when the pass framework has finished calling :ref:`runOnFunction
-<writing-an-llvm-pass-runOnFunction>` for every function in the program being
-compiled.
+when the pass framework has finished calling :ref:`runOnSCC
+<writing-an-llvm-pass-runOnSCC>` for every SCC in the program being compiled.
 
 .. _writing-an-llvm-pass-FunctionPass:
 
@@ -456,7 +455,7 @@ To be explicit, ``FunctionPass`` subclas
 #. Inspect or modify a ``Function`` other than the one currently being processed.
 #. Add or remove ``Function``\ s from the current ``Module``.
 #. Add or remove global variables from the current ``Module``.
-#. Maintain state across invocations of:ref:`runOnFunction
+#. Maintain state across invocations of :ref:`runOnFunction
    <writing-an-llvm-pass-runOnFunction>` (including global data).
 
 Implementing a ``FunctionPass`` is usually straightforward (See the :ref:`Hello





More information about the llvm-commits mailing list