Improve description, add warning

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

1 files changed, 6 insertions, 2 deletions

diff --git a/include/llvm/Transforms/Scalar.h b/include/llvm/Transforms/Scalar.h
index 8b0a1d72ca..7acc7a6a12 100644
--- a/include/llvm/Transforms/Scalar.h
+++ b/include/llvm/Transforms/Scalar.h
@@ -262,8 +262,12 @@ FunctionPass *createLowerSwitchPass();
 FunctionPass *createLowerSelectPass(bool OnlyFP = false);
 
 //===----------------------------------------------------------------------===//
-// This pass converts 'invoke' instructions calls, and 'unwind' instructions
-// into calls to abort().
+// This pass converts invoke and unwind instructions to use sjlj exception
+// handling mechanisms.  Note that after this pass runs the CFG is not entirely
+// accurate (exceptional control flow edges are not correct anymore) so only
+// very simple things should be done after the lowerinvoke pass has run (like
+// generation of native code).  This should not be used as a general purpose "my
+// LLVM-to-LLVM pass doesn't support the invoke instruction yet" lowering pass.
 //
 FunctionPass *createLowerInvokePass();
 extern const PassInfo *LowerInvokePassID;