Reapply r73647 in a non-broken form.

[oota-llvm.git] / include / llvm / System / Program.h

diff --git a/include/llvm/System/Program.h b/include/llvm/System/Program.h
index 69e38321a1b5a4806920e6f8c1ff0aa1ee8004fd..37f55466a50d717b5dc51ac7050b503d7a8a6eea 100644 (file)
--- a/include/llvm/System/Program.h
+++ b/include/llvm/System/Program.h
@@ -15,8 +15,6 @@
 #define LLVM_SYSTEM_PROGRAM_H
 
 #include "llvm/System/Path.h"
-#include "llvm/System/IncludeFile.h"
-#include <vector>
 
 namespace llvm {
 namespace sys {
@@ -49,12 +47,12 @@ namespace sys {
       /// called then a std::string is thrown.
       /// @returns an integer result code indicating the status of the program.
       /// A zero or positive value indicates the result code of the program. A
-      /// negative value is the signal number on which it terminated. 
+      /// negative value is the signal number on which it terminated.
       /// @see FindProgrambyName
       /// @brief Executes the program with the given set of \p args.
       static int ExecuteAndWait(
-        const Path& path,  ///< sys::Path object providing the path of the 
-          ///< program to be executed. It is presumed this is the result of 
+        const Path& path,  ///< sys::Path object providing the path of the
+          ///< program to be executed. It is presumed this is the result of
           ///< the FindProgramByName method.
         const char** args, ///< A vector of strings that are passed to the
           ///< program.  The first element should be the name of the program.
@@ -67,6 +65,9 @@ namespace sys {
           ///< should have a size of at least three. If the pointer in the array
           ///< are not null, then the inferior process's stdin(0), stdout(1),
           ///< and stderr(2) will be redirected to the corresponding Paths.
+          ///< When an empty Path is passed in, the corresponding file
+          ///< descriptor will be disconnected (ie, /dev/null'd) in a portable
+          ///< way.
         unsigned secondsToWait = 0, ///< If non-zero, this specifies the amount
           ///< of time to wait for the child process to exit. If the time
           ///< expires, the child is killed and this call returns. If zero,
@@ -74,10 +75,10 @@ namespace sys {
           ///< it doesn't.
         unsigned memoryLimit = 0, ///< If non-zero, this specifies max. amount
           ///< of memory can be allocated by process. If memory usage will be
-          ///< higher limit, the child is killed and this call returns. If zero -
-          ///< no memory limit.
+          ///< higher limit, the child is killed and this call returns. If zero
+          ///< - no memory limit.
         std::string* ErrMsg = 0 ///< If non-zero, provides a pointer to a string
-          ///< instance in which error messages will be returned. If the string 
+          ///< instance in which error messages will be returned. If the string
           ///< is non-empty upon return an error occurred while invoking the
           ///< program.
       );
@@ -90,6 +91,4 @@ namespace sys {
 }
 }
 
-FORCE_DEFINING_FILE_TO_BE_LINKED(SystemProgram)
-
 #endif