summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJustin Bogner <mail@justinbogner.com>2014-11-18 05:00:52 +0000
committerJustin Bogner <mail@justinbogner.com>2014-11-18 05:00:52 +0000
commit85b4cd478a7f6ae9a29abce8e2a6bca689ebcb87 (patch)
treeaa8fdbe7c885ba6d5ea93ae0221688175b366138
parent9211ec4fcc45df0439e1cc5fdcf1fb741c129efc (diff)
downloadbcm5719-llvm-85b4cd478a7f6ae9a29abce8e2a6bca689ebcb87.tar.gz
bcm5719-llvm-85b4cd478a7f6ae9a29abce8e2a6bca689ebcb87.zip
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. llvm-svn: 222222
-rw-r--r--llvm/docs/WritingAnLLVMPass.rst7
1 files changed, 3 insertions, 4 deletions
diff --git a/llvm/docs/WritingAnLLVMPass.rst b/llvm/docs/WritingAnLLVMPass.rst
index cfbda042cc5..349717a2d8d 100644
--- a/llvm/docs/WritingAnLLVMPass.rst
+++ b/llvm/docs/WritingAnLLVMPass.rst
@@ -434,9 +434,8 @@ The ``doFinalization(CallGraph &)`` method
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`` subclasses are not allowed to:
#. 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
OpenPOWER on IntegriCloud