Add a function to remove whole directorys on fatal signal.

Doxygenify function comments.


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

1 files changed, 14 insertions, 6 deletions

diff --git a/include/llvm/System/Signals.h b/include/llvm/System/Signals.h
index ebec15ea1d..9f4c00a488 100644
--- a/include/llvm/System/Signals.h
+++ b/include/llvm/System/Signals.h
@@ -15,18 +15,26 @@
 #ifndef LLVM_SYSTEM_SIGNALS_H
 #define LLVM_SYSTEM_SIGNALS_H
 
-#include <string>
+#include "llvm/System/Path.h"
 
 namespace llvm {
 
-  /// RemoveFileOnSignal - This function registers signal handlers to ensure
-  /// that if a signal gets delivered that the named file is removed.
-  ///
+  /// This function registers signal handlers to ensure that if a signal gets 
+  /// delivered that the named file is removed.
+  /// @brief Remove a file if a fatal signal occurs.
   void RemoveFileOnSignal(const std::string &Filename);
 
-  /// PrintStackTraceOnErrorSignal - When an error signal (such as SIBABRT or
-  /// SIGSEGV) is delivered to the process, print a stack trace and then exit.
+  /// This function registers a signal handler to ensure that if a fatal signal
+  /// gets delivered to the process that the named directory and all its
+  /// contents are removed.
+  /// @brief Remove a directory if a fatal signal occurs.
+  void RemoveDirectoryOnSignal(const llvm::sys::Path& path);
+
+  /// When an error signal (such as SIBABRT or SIGSEGV) is delivered to the 
+  /// process, print a stack trace and then exit.
+  /// @brief Print a stack trace if a fatal signal occurs.
   void PrintStackTraceOnErrorSignal();
+
 } // End llvm namespace
 
 #endif