base: Mention openFile throwing does-not-exist-errors on FIFOs
authorBen Gamari <bgamari.foss@gmail.com>
Thu, 22 Nov 2018 16:33:39 +0000 (11:33 -0500)
committerBen Gamari <ben@smart-cactus.org>
Thu, 22 Nov 2018 17:11:16 +0000 (12:11 -0500)
As discussed in #15715, the POSIX specification specifies that
attempting to open a FIFO in write-only mode when the FIFO has no
readers will fail with -ENOENT.

[skip ci]

Test Plan: Read it

Reviewers: hvr

Subscribers: rwbarton, carter

GHC Trac Issues: #15715

Differential Revision: https://phabricator.haskell.org/D5295

libraries/base/GHC/IO/Handle/FD.hs

index 883bc5f..6417976 100644 (file)
@@ -131,7 +131,9 @@ addFilePathToIOError fun fp ioe
 --  * 'System.IO.Error.isAlreadyInUseError' if the file is already open and
 --    cannot be reopened;
 --
---  * 'System.IO.Error.isDoesNotExistError' if the file does not exist; or
+--  * 'System.IO.Error.isDoesNotExistError' if the file does not exist or
+--    (on POSIX systems) is a FIFO without a reader and 'WriteMode' was
+--    requested; or
 --
 --  * 'System.IO.Error.isPermissionError' if the user does not have permission
 --     to open the file.