[PATCH] D59258: [Docs] Add a note about legacy FunctionPassManager to the LLVM tutorial.

[Kristina Brooks via Phabricator via llvm-commits]

kristina created this revision.
kristina added reviewers: fedor.sergeev, chandlerc, dblaikie.
Herald added a subscriber: jdoerfert.
Herald added a project: LLVM.

It seems to confuse some people, I figured it may be 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.


Repository:
  rL LLVM

https://reviews.llvm.org/D59258

Files:
  docs/tutorial/LangImpl04.rst


Index: docs/tutorial/LangImpl04.rst
===================================================================
--- docs/tutorial/LangImpl04.rst
+++ docs/tutorial/LangImpl04.rst
@@ -94,6 +94,14 @@
 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


-------------- next part --------------
A non-text attachment was scrubbed...
Name: D59258.190265.patch
Type: text/x-patch
Size: 853 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/llvm-commits/attachments/20190312/142466f9/attachment.bin>