Doc update

This commit is contained in:
Julian Ospald 2016-05-18 13:42:31 +02:00
parent 1bf27258c1
commit 646fe7cfea
No known key found for this signature in database
GPG Key ID: 511B62C09D50CD28
1 changed files with 3 additions and 3 deletions

View File

@ -6,7 +6,7 @@
-- |Provides an alternative for `System.Posix.IO.ByteString.openFd` -- |Provides an alternative for `System.Posix.IO.ByteString.openFd`
-- which gives us more control on what status flags to pass to the -- which gives us more control on what status flags to pass to the
-- low-level `open(2)` call, in contrast to the unix package. -- low-level @open(2)@ call, in contrast to the unix package.
module System.Posix.FD ( module System.Posix.FD (
openFd openFd
) where ) where
@ -50,10 +50,10 @@ open_ str how optional_flags maybe_mode = do
-- --
-- Note that passing `Just x` as the 4th argument triggers the -- Note that passing `Just x` as the 4th argument triggers the
-- `oCreat` status flag, which must be set when you pass in `oExcl` -- `oCreat` status flag, which must be set when you pass in `oExcl`
-- to the status flags. Also see the manpage for `open(2)`. -- to the status flags. Also see the manpage for @open(2)@.
openFd :: RawFilePath openFd :: RawFilePath
-> Posix.OpenMode -> Posix.OpenMode
-> [Flags] -- ^ status flags of open(2) -> [Flags] -- ^ status flags of @open(2)@
-> Maybe Posix.FileMode -- ^ Just x => creates the file with the given modes, Nothing => the file must exist. -> Maybe Posix.FileMode -- ^ Just x => creates the file with the given modes, Nothing => the file must exist.
-> IO Posix.Fd -> IO Posix.Fd
openFd name how optional_flags maybe_mode = openFd name how optional_flags maybe_mode =