]> granicus.if.org Git - llvm/commitdiff
[Docs] Add note about legacy PM to Ch4 of tutorial
authorKristina Brooks <notstina@gmail.com>
Tue, 12 Mar 2019 15:44:18 +0000 (15:44 +0000)
committerKristina Brooks <notstina@gmail.com>
Tue, 12 Mar 2019 15:44:18 +0000 (15:44 +0000)
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

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@355930 91177308-0d34-0410-b5e6-96231b3b80d8

docs/tutorial/LangImpl04.rst

index 8927a912cc20e4d069990a21749bc2d90869d455..bdd21d6cd4ae192e33f717879cf1a6ac5ee6e90e 100644 (file)
@@ -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