Skip to content
Snippets Groups Projects
Commit 85b4cd47 authored by Justin Bogner's avatar Justin Bogner
Browse files

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
parent 9211ec4f
No related branches found
No related tags found
No related merge requests found
...@@ -434,9 +434,8 @@ The ``doFinalization(CallGraph &)`` method ...@@ -434,9 +434,8 @@ The ``doFinalization(CallGraph &)`` method
virtual bool doFinalization(CallGraph &CG); virtual bool doFinalization(CallGraph &CG);
The ``doFinalization`` method is an infrequently used method that is called The ``doFinalization`` method is an infrequently used method that is called
when the pass framework has finished calling :ref:`runOnFunction when the pass framework has finished calling :ref:`runOnSCC
<writing-an-llvm-pass-runOnFunction>` for every function in the program being <writing-an-llvm-pass-runOnSCC>` for every SCC in the program being compiled.
compiled.
.. _writing-an-llvm-pass-FunctionPass: .. _writing-an-llvm-pass-FunctionPass:
...@@ -456,7 +455,7 @@ To be explicit, ``FunctionPass`` subclasses are not allowed to: ...@@ -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. #. Inspect or modify a ``Function`` other than the one currently being processed.
#. Add or remove ``Function``\ s from the current ``Module``. #. Add or remove ``Function``\ s from the current ``Module``.
#. Add or remove global variables 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). <writing-an-llvm-pass-runOnFunction>` (including global data).
Implementing a ``FunctionPass`` is usually straightforward (See the :ref:`Hello Implementing a ``FunctionPass`` is usually straightforward (See the :ref:`Hello
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment