X-Git-Url: http://git.megacz.com/?a=blobdiff_plain;f=System%2FExit.hs;h=7eb17cfbfe27f02b10c6a6dd1e2c00ff7d7816a0;hb=HEAD;hp=e211ca58519ea9f16521947fddfe52c7d24d1bd8;hpb=2b2397221c29a275630c62d4982caedc2c7cd987;p=ghc-base.git

diff --git a/System/Exit.hs b/System/Exit.hs
index e211ca5..7eb17cf 100644
--- a/System/Exit.hs
+++ b/System/Exit.hs
@@ -1,3 +1,5 @@
+{-# LANGUAGE CPP #-}
+
 -----------------------------------------------------------------------------
 -- |
 -- Module      :  System.Exit
@@ -23,7 +25,8 @@ module System.Exit
 import Prelude
 
 #ifdef __GLASGOW_HASKELL__
-import GHC.IOBase
+import GHC.IO
+import GHC.IO.Exception
 #endif
 
 #ifdef __HUGS__
@@ -41,30 +44,39 @@ import System
 -- ---------------------------------------------------------------------------
 -- exitWith
 
--- | Computation 'exitWith' @code@ throws 'ExitException' @code@.
+-- | Computation 'exitWith' @code@ throws 'ExitCode' @code@.
 -- Normally this terminates the program, returning @code@ to the
--- program's caller.  Before the program terminates, any open or
--- semi-closed handles are first closed.
+-- program's caller.
+--
+-- On program termination, the standard 'Handle's 'stdout' and
+-- 'stderr' are flushed automatically; any other buffered 'Handle's
+-- need to be flushed manually, otherwise the buffered data will be
+-- discarded.
 --
 -- A program that fails in any other way is treated as if it had
 -- called 'exitFailure'.
 -- A program that terminates successfully without calling 'exitWith'
 -- explicitly is treated as it it had called 'exitWith' 'ExitSuccess'.
 --
--- As an 'ExitException' is not an 'IOError', 'exitWith' bypasses
+-- As an 'ExitCode' is not an 'IOError', 'exitWith' bypasses
 -- the error handling in the 'IO' monad and cannot be intercepted by
--- 'catch' from the "Prelude".  However it is an 'Exception', and can
+-- 'catch' from the "Prelude".  However it is a 'SomeException', and can
 -- be caught using the functions of "Control.Exception".  This means
 -- that cleanup computations added with 'Control.Exception.bracket'
 -- (from "Control.Exception") are also executed properly on 'exitWith'.
-
+--
+-- Note: in GHC, 'exitWith' should be called from the main program
+-- thread in order to exit the process.  When called from another
+-- thread, 'exitWith' will throw an 'ExitException' as normal, but the
+-- exception will not cause the process itself to exit.
+--
 #ifndef __NHC__
 exitWith :: ExitCode -> IO a
 exitWith ExitSuccess = throwIO ExitSuccess
 exitWith code@(ExitFailure n)
   | n /= 0 = throwIO code
 #ifdef __GLASGOW_HASKELL__
-  | otherwise = ioError (IOError Nothing InvalidArgument "exitWith" "ExitFailure 0" Nothing)
+  | otherwise = ioError (IOError Nothing InvalidArgument "exitWith" "ExitFailure 0" Nothing Nothing)
 #endif
 #endif  /* ! __NHC__ */
 
@@ -76,6 +88,6 @@ exitFailure = exitWith (ExitFailure 1)
 
 -- | The computation 'exitSuccess' is equivalent to
 -- 'exitWith' 'ExitSuccess', It terminates the program
--- sucessfully.
+-- successfully.
 exitSuccess :: IO a
 exitSuccess = exitWith ExitSuccess