Commit 780768a7 authored by Michael Snoyman's avatar Michael Snoyman
Browse files

Fix some doc markup (thanks @hvr)

parent 52cad652
......@@ -274,7 +274,7 @@ cleanupProcess (mb_stdin, mb_stdout, mb_stderr,
-- arguments. It does not wait for the program to finish, but returns the
-- 'ProcessHandle'.
--
-- /Since: 1.2.0.0/
-- @since 1.2.0.0
spawnProcess :: FilePath -> [String] -> IO ProcessHandle
spawnProcess cmd args = do
(_,_,_,p) <- createProcess_ "spawnProcess" (proc cmd args)
......@@ -283,7 +283,7 @@ spawnProcess cmd args = do
-- | Creates a new process to run the specified shell command.
-- It does not wait for the program to finish, but returns the 'ProcessHandle'.
--
-- /Since: 1.2.0.0/
-- @since 1.2.0.0
spawnCommand :: String -> IO ProcessHandle
spawnCommand cmd = do
(_,_,_,p) <- createProcess_ "spawnCommand" (shell cmd)
......@@ -302,7 +302,7 @@ spawnCommand cmd = do
-- @callProcess@ will wait (block) until the process has been
-- terminated.
--
-- /Since: 1.2.0.0/
-- @since 1.2.0.0
callProcess :: FilePath -> [String] -> IO ()
callProcess cmd args = do
exit_code <- withCreateProcess_ "callProcess"
......@@ -320,7 +320,7 @@ callProcess cmd args = do
-- @callCommand@ will wait (block) until the process has been
-- terminated.
--
-- /Since: 1.2.0.0/
-- @since 1.2.0.0
callCommand :: String -> IO ()
callCommand cmd = do
exit_code <- withCreateProcess_ "callCommand"
......@@ -430,7 +430,7 @@ readProcess cmd args = readCreateProcess $ proc cmd args
--
-- Note that @Handle@s provided for @std_in@ or @std_out@ via the CreateProcess
-- record will be ignored.
-- /Since: 1.2.3.0/
-- @since 1.2.3.0
readCreateProcess
:: CreateProcess
......@@ -499,7 +499,7 @@ readProcessWithExitCode cmd args =
-- Note that @Handle@s provided for @std_in@, @std_out@, or @std_err@ via the CreateProcess
-- record will be ignored.
--
-- /Since: 1.2.3.0/
-- @since 1.2.3.0
readCreateProcessWithExitCode
:: CreateProcess
-> String -- ^ standard input
......@@ -934,7 +934,7 @@ rawSystem cmd args = system (showCommandForUser cmd args)
-- | Create a pipe for interprocess communication and return a
-- @(readEnd, writeEnd)@ `Handle` pair.
--
-- /Since: 1.2.1.0/
-- @since 1.2.1.0
createPipe :: IO (Handle, Handle)
#if !mingw32_HOST_OS
createPipe = do
......
......@@ -181,18 +181,18 @@ data CreateProcess = CreateProcess{
--
-- On Windows this has no effect.
--
-- /Since: 1.2.0.0/
-- @since 1.2.0.0
detach_console :: Bool, -- ^ Use the windows DETACHED_PROCESS flag when creating the process; does nothing on other platforms.
--
-- /Since: 1.3.0.0/
-- @since 1.3.0.0
create_new_console :: Bool, -- ^ Use the windows CREATE_NEW_CONSOLE flag when creating the process; does nothing on other platforms.
--
-- Default: @False@
--
-- /Since: 1.3.0.0/
-- @since 1.3.0.0
new_session :: Bool -- ^ Use posix setsid to start the new process in a new session; does nothing on other platforms.
--
-- /Since: 1.3.0.0/
-- @since 1.3.0.0
}
data CmdSpec
......@@ -224,7 +224,7 @@ data CmdSpec
-- | construct a `ShellCommand` from a string literal
--
-- /Since: 1.2.1.0/
-- @since 1.2.1.0
instance IsString CmdSpec where
fromString = ShellCommand
......@@ -249,7 +249,7 @@ data StdStream
-- for some time, and is part of the "System.Process" module since version
-- 1.2.1.0.
--
-- /Since: 1.2.1.0/
-- @since 1.2.1.0
createProcess_
:: String -- ^ function name (for error messages)
-> CreateProcess
......
......@@ -2,7 +2,7 @@
## 1.3.0.0 (unreleased)
* Add StdStream(NoStream) to have standard handles closed. [#13](https://github.com/haskell/process/pull/13)
* Add `StdStream(NoStream)` to have standard handles closed. [#13](https://github.com/haskell/process/pull/13)
* Support for Windows `DETACHED_PROCESS` and `setsid` [#32](https://github.com/haskell/process/issues/32)
* Support for Windows `CREATE_NEW_CONSOLE` [#38](https://github.com/haskell/process/issues/38)
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment