From deffb630210e35da146c3cee5972fb405b0f00b5 Mon Sep 17 00:00:00 2001
From: Benoit Daloze <eregontp@gmail.com>
Date: Thu, 17 Sep 2020 14:52:04 +0200
Subject: Document the various scheduler hooks

---
 test/fiber/scheduler.rb | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/test/fiber/scheduler.rb b/test/fiber/scheduler.rb
index f7a773ade1..193a824f7f 100644
--- a/test/fiber/scheduler.rb
+++ b/test/fiber/scheduler.rb
@@ -114,6 +114,7 @@ class Scheduler
     return true
   end
 
+  # Used for Kernel#sleep and Mutex#sleep
   def kernel_sleep(duration = nil)
     # p [__method__, duration]
     if duration
@@ -125,6 +126,7 @@ class Scheduler
     return true
   end
 
+  # Used when blocking on synchronization (Mutex#lock, Queue#pop, SizedQueue#push, ...)
   def block(blocker)
     # p [__method__, blocker]
     @locking += 1
@@ -133,6 +135,7 @@ class Scheduler
     @locking -= 1
   end
 
+  # Used when synchronization wakes up a previously-blocked fiber (Mutex#unlock, Queue#push, ...)
   def unblock(blocker, fiber)
     # p [__method__, blocker, fiber]
     @lock.synchronize do
-- 
cgit v1.2.3