Skip to content

Commit

Permalink
[Docs] Add note about legacy PM to Ch4 of tutorial
Browse files Browse the repository at this point in the history
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
  • Loading branch information
christinaa committed Mar 12, 2019
1 parent b69a501 commit 1417967
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions llvm/docs/tutorial/LangImpl04.rst
Expand Up @@ -94,6 +94,14 @@ use, in the form of "passes".
LLVM Optimization Passes
========================

.. warning::

Due to the transition to the new PassManager infrastructure this tutorial
is based on ``llvm::legacy::FunctionPassManager`` which can be found in
`LegacyPassManager.h <http://llvm.org/doxygen/classllvm_1_1legacy_1_1FunctionPassManager.html>`_.
For the purpose of the this tutorial the above should be used until
the pass manager transition is complete.

LLVM provides many optimization passes, which do many different sorts of
things and have different tradeoffs. Unlike other systems, LLVM doesn't
hold to the mistaken notion that one set of optimizations is right for
Expand Down

0 comments on commit 1417967

Please sign in to comment.