[commit: packages/process] master, wip/issue15: Tweak Haddock markup and add /since/-annotation (90540d7)

git at git.haskell.org git at git.haskell.org
Thu Mar 19 11:37:23 UTC 2015


Repository : ssh://git@git.haskell.org/process

On branches: master,wip/issue15
Link       : http://ghc.haskell.org/trac/ghc/changeset/90540d7cf0435bf433b97186994b137ba3ffc41a/process

>---------------------------------------------------------------

commit 90540d7cf0435bf433b97186994b137ba3ffc41a
Author: Herbert Valerio Riedel <hvr at gnu.org>
Date:   Thu Dec 18 22:22:03 2014 +0100

    Tweak Haddock markup and add /since/-annotation


>---------------------------------------------------------------

90540d7cf0435bf433b97186994b137ba3ffc41a
 System/Process/Internals.hs | 16 ++++++++++------
 1 file changed, 10 insertions(+), 6 deletions(-)

diff --git a/System/Process/Internals.hs b/System/Process/Internals.hs
index b3fd8bd..90651d0 100644
--- a/System/Process/Internals.hs
+++ b/System/Process/Internals.hs
@@ -102,7 +102,7 @@ import System.FilePath
 -- ProcessHandle type
 
 {- | A handle to a process, which can be used to wait for termination
-     of the process using 'waitForProcess'.
+     of the process using 'System.Process.waitForProcess'.
 
      None of the process-creation functions in this library wait for
      termination: they all return a 'ProcessHandle' which may be used
@@ -211,6 +211,8 @@ data CmdSpec
 
 
 -- | construct a `ShellCommand` from a string literal
+--
+-- /Since: 1.2.1.0/
 instance IsString CmdSpec where
   fromString = ShellCommand
 
@@ -222,17 +224,19 @@ data StdStream
                              -- and newline translation mode (just
                              -- like @Handle at s created by @openFile@).
 
--- | This function is almost identical to @createProcess at . The only differences
--- are:
+-- | This function is almost identical to
+-- 'System.Process.createProcess'. The only differences are:
 --
--- * @Handle at s provided via @UseHandle@ are not closed automatically.
+-- * 'Handle's provided via 'UseHandle' are not closed automatically.
 --
 -- * This function takes an extra @String@ argument to be used in creating
 --   error messages.
 --
--- This function has been available from the @System.Process.Internals@ module
--- for some time, and is part of the @System.Process@ module since version
+-- This function has been available from the "System.Process.Internals" module
+-- for some time, and is part of the "System.Process" module since version
 -- 1.2.1.0.
+--
+-- /Since: 1.2.1.0/
 createProcess_
   :: String                     -- ^ function name (for error messages)
   -> CreateProcess



More information about the ghc-commits mailing list