summaryrefslogtreecommitdiffstats
path: root/llvm/docs/tutorial
diff options
context:
space:
mode:
authorKristina Brooks <notstina@gmail.com>2019-03-12 15:44:18 +0000
committerKristina Brooks <notstina@gmail.com>2019-03-12 15:44:18 +0000
commit14179673e27b3a0620f4dfd92fb40e8f1c38605a (patch)
tree82aee091135e01c29ed76dbe82f514e7dbafbdfa /llvm/docs/tutorial
parentb69a50115bd5db998dd972d2017b2332d4033b5c (diff)
downloadbcm5719-llvm-14179673e27b3a0620f4dfd92fb40e8f1c38605a.tar.gz
bcm5719-llvm-14179673e27b3a0620f4dfd92fb40e8f1c38605a.zip
[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
Diffstat (limited to 'llvm/docs/tutorial')
-rw-r--r--llvm/docs/tutorial/LangImpl04.rst8
1 files changed, 8 insertions, 0 deletions
diff --git a/llvm/docs/tutorial/LangImpl04.rst b/llvm/docs/tutorial/LangImpl04.rst
index 8927a912cc2..bdd21d6cd4a 100644
--- a/llvm/docs/tutorial/LangImpl04.rst
+++ b/llvm/docs/tutorial/LangImpl04.rst
@@ -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
OpenPOWER on IntegriCloud