From fa80782864895fe614e1b83416736014e68c8b35 Mon Sep 17 00:00:00 2001
From: Andreas Klebinger <klebinger.andreas@gmx.at>
Date: Tue, 23 Jun 2020 12:49:21 +0200
Subject: winio: Expand BlockedOnIOCompletion description.

---
 includes/rts/Constants.h | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/includes/rts/Constants.h b/includes/rts/Constants.h
index f1ca25a6f3..043099bd1a 100644
--- a/includes/rts/Constants.h
+++ b/includes/rts/Constants.h
@@ -257,7 +257,9 @@
 #define ThreadMigrating     13
 
 /* Lightweight non-deadlock checked version of MVar.  Used for the why_blocked
-   field of a TSO.  */
+   field of a TSO. Threads blocked for this reason are not forcibly release by
+   the GC, as we expect them to be unblocked in the future based on outstanding
+   IO events.  */
 #define BlockedOnIOCompletion  15
 
 /* Next number is 16.  */
-- 
cgit v1.2.1