summaryrefslogtreecommitdiff
path: root/libraries
diff options
context:
space:
mode:
authorBen Gamari <ben@smart-cactus.org>2015-10-23 17:09:31 +0200
committerBen Gamari <ben@smart-cactus.org>2015-10-23 17:43:49 +0200
commitfd63ea5686fe5b856c3ebdc5f28bf7a2547bd96f (patch)
tree60dde5bb92e617a62c7c9ad3a4aeb8422f757e74 /libraries
parent0afba67f703ab0ba8cd041167144169d67e14501 (diff)
downloadhaskell-fd63ea5686fe5b856c3ebdc5f28bf7a2547bd96f.tar.gz
base: Note platform dependence of registerFd
Just a documentation change. Fixes #10736.
Diffstat (limited to 'libraries')
-rw-r--r--libraries/base/GHC/Event/Manager.hs5
1 files changed, 5 insertions, 0 deletions
diff --git a/libraries/base/GHC/Event/Manager.hs b/libraries/base/GHC/Event/Manager.hs
index b674866ad8..a94f8e8247 100644
--- a/libraries/base/GHC/Event/Manager.hs
+++ b/libraries/base/GHC/Event/Manager.hs
@@ -305,6 +305,11 @@ step mgr@EventManager{..} = do
-- | Register interest in the given events, without waking the event
-- manager thread. The 'Bool' return value indicates whether the
-- event manager ought to be woken.
+--
+-- Note that the event manager is generally implemented in terms of the
+-- platform's @selectg@ or @epoll@ system call, which tend to vary in
+-- what sort of fds are permitted. For instance, waiting on regular files
+-- is not allowed on many platforms.
registerFd_ :: EventManager -> IOCallback -> Fd -> Event -> Lifetime
-> IO (FdKey, Bool)
registerFd_ mgr@(EventManager{..}) cb fd evs lt = do