Skip to content

Commit 1417967

Browse files
committed
[Docs] Add note about legacy PM to Ch4 of tutorial
Add a note about legacy FunctionPassManager to the LLVM tutorial. It seems to confuse some people, worth adding a warning to the tutorial to elaborate and suggest using `llvm::legacy::FunctionPassManager` for now. Not a perfect solution but hopefully will avoid confusion in the meantime. Differential Revision: https://reviews.llvm.org/D59258 llvm-svn: 355930
1 parent b69a501 commit 1417967

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

llvm/docs/tutorial/LangImpl04.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,14 @@ use, in the form of "passes".
9494
LLVM Optimization Passes
9595
========================
9696

97+
.. warning::
98+
99+
Due to the transition to the new PassManager infrastructure this tutorial
100+
is based on ``llvm::legacy::FunctionPassManager`` which can be found in
101+
`LegacyPassManager.h <http://llvm.org/doxygen/classllvm_1_1legacy_1_1FunctionPassManager.html>`_.
102+
For the purpose of the this tutorial the above should be used until
103+
the pass manager transition is complete.
104+
97105
LLVM provides many optimization passes, which do many different sorts of
98106
things and have different tradeoffs. Unlike other systems, LLVM doesn't
99107
hold to the mistaken notion that one set of optimizations is right for

0 commit comments

Comments
 (0)