Mention that llvm_report_error() does not return.
authorTorok Edwin <edwintorok@gmail.com>
Sun, 12 Jul 2009 21:01:44 +0000 (21:01 +0000)
committerTorok Edwin <edwintorok@gmail.com>
Sun, 12 Jul 2009 21:01:44 +0000 (21:01 +0000)
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@75428 91177308-0d34-0410-b5e6-96231b3b80d8

include/llvm/Support/ErrorHandling.h

index d9938a1..07faba7 100644 (file)
@@ -42,6 +42,8 @@ namespace llvm {
   /// Reports a serious error, calling any installed error handler.
   /// If no error handler is installed the default is to print the message to
   /// standard error, followed by a newline.
+  /// After the error handler is called this function will call exit(1), it 
+  /// does not return.
   void llvm_report_error(const std::string &reason) NORETURN;
 
   /// This function calls abort(), and prints the optional message to stderr.