[commit: packages/process] master: Fix some doc markup (thanks @hvr) (780768a)

git at git.haskell.org git at git.haskell.org
Mon Nov 2 06:23:57 UTC 2015


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

On branch  : master
Link       : http://ghc.haskell.org/trac/ghc/changeset/780768a7699f63ea602dcf9d19e214a624c297e1/process

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

commit 780768a7699f63ea602dcf9d19e214a624c297e1
Author: Michael Snoyman <michael at snoyman.com>
Date:   Tue Aug 25 23:54:37 2015 +0300

    Fix some doc markup (thanks @hvr)


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

780768a7699f63ea602dcf9d19e214a624c297e1
 System/Process.hsc          | 14 +++++++-------
 System/Process/Internals.hs | 12 ++++++------
 changelog.md                |  2 +-
 3 files changed, 14 insertions(+), 14 deletions(-)

diff --git a/System/Process.hsc b/System/Process.hsc
index 144daf8..297a311 100644
--- a/System/Process.hsc
+++ b/System/Process.hsc
@@ -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 at 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 at 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
diff --git a/System/Process/Internals.hs b/System/Process/Internals.hs
index cfe34ef..40f2f92 100644
--- a/System/Process/Internals.hs
+++ b/System/Process/Internals.hs
@@ -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
diff --git a/changelog.md b/changelog.md
index d19ee0b..264a405 100644
--- a/changelog.md
+++ b/changelog.md
@@ -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)
 



More information about the ghc-commits mailing list