Pipe 2.1.1 → 2.1.2

raw patch · 3 files changed

+14/−11 lines, 3 filesPVP ok

version bump matches the API change (PVP)

API changes (from Hackage documentation)

Files

• LICENSE.txt +1/−1
• Pipe.cabal +1/−1
• System/Process/Pipe.hs +12/−9

@@ -1,4 +1,4 @@-Copyright (c) 2008, Matti Niemenmaa
+Copyright (c) 2008-2009, Matti Niemenmaa
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

@@ -1,7 +1,7 @@ Cabal-Version: >= 1.2
 
 Name:        Pipe
-Version:     2.1.1
+Version:     2.1.2
 Homepage:    http://iki.fi/matti.niemenmaa/pipe/
 Synopsis:    Process piping library
 Category:    System

@@ -3,19 +3,19 @@ -------------------------------------------------------------------------------
 -- |
 -- Module    : System.Process.Pipe
--- Copyright : (c) Matti Niemenmaa 2008
+-- Copyright : (c) Matti Niemenmaa 2008-2009
 -- License   : BSD (see LICENSE.txt)
 --
--- Maintainer  : Matti Niemenmaa <matti.niemenmaa+web@iki.fi>
+-- Maintainer  : Matti Niemenmaa <matti.niemenmaa+pipe@iki.fi>
 -- Stability   : experimental
 -- Portability : portable
 --
 -- Operations for piping data through multiple processes.
 --
--- 'pipe' is the most general function, with 'pipe\'' and 'pipeString' provided
+-- 'pipe' is the most general function, with 'pipe'' and 'pipeString' provided
 -- for convenience purposes.
 --
--- 'handlePipe', 'filePipe', and 'filePipe\'' are for the common file-to-file
+-- 'handlePipe', 'filePipe', and 'filePipe'' are for the common file-to-file
 -- case and behave somewhat differently.
 --
 -- Whenever specifying a path to a process, explicitly specifying the current
@@ -87,8 +87,11 @@ --
 -- An exception is thrown if the list of programs is empty.
 --
--- The writer function is called in a 'forkIO'\'d thread, allowing this to be
--- lazy.
+-- The writer function is called in a 'forkIO''d thread, allowing this to be
+-- lazy. That thread also calls 'waitForProcess' when done writing so that the
+-- processes get terminated cleanly; this means that the runtime should be
+-- multithreaded, or the call will block all threads and this function may
+-- deadlock. (In GHC, compile with @-threaded@.)
 --
 -- SIGPIPE is ignored in the writer thread. Likewise, any IOExceptions are
 -- caught and ignored.
@@ -112,7 +115,7 @@    reader out
 
 -- | A convenience function for when you don't care about the working
--- directory, 'pipe\'' uses ".".
+-- directory, 'pipe'' uses \".\".
 pipe' :: (Handle -> a -> IO ()) -> (Handle -> IO b)
       -> [(FilePath,[String])]
       -> a -> IO b
@@ -125,8 +128,8 @@ 
 -- | A function for the common case of piping from a 'Handle' to a 'Handle'.
 --
--- Note that this is not a convenient frontend for 'pipe' and is fundamentally
--- different in the following ways:
+-- Note that this is not merely a convenient frontend for 'pipe' and is
+-- fundamentally different in the following ways:
 --
 -- * A null list of programs is allowed, in which case the contents of the
 --   input Handle are simply written to the output Handle.