From 1b5daf930adc839c539ee33cb8e1c05b856c9596 Mon Sep 17 00:00:00 2001
From: Kovid Goyal <kovid@kovidgoyal.net>
Date: Thu, 23 Jan 2020 15:08:54 +0530
Subject: [PATCH] Make the comment explaining wayland polling more detailed

---
 glfw/wl_window.c | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/glfw/wl_window.c b/glfw/wl_window.c
index 5c7aa0c09..86d4cdfd5 100644
--- a/glfw/wl_window.c
+++ b/glfw/wl_window.c
@@ -788,6 +788,8 @@ handleEvents(monotonic_t timeout)
 
     // we pass in wayland_read_events to ensure that the above wl_display_prepare_read call
     // is followed by either wl_display_cancel_read or wl_display_read_events
+    // before any events/timers are dispatched. This allows other wayland functions
+    // to be called in the event/timer handlers without causing a deadlock
     bool display_read_ok = pollForEvents(&_glfw.wl.eventLoopData, timeout, wayland_read_events);
     EVDBG("display_read_ok: %d", display_read_ok);
     if (display_read_ok) {