From 0d899a6ba7758d455a10be0fb126848e9602b7e1 Mon Sep 17 00:00:00 2001
From: "Enrico Weigelt, metux IT consult" <info@metux.net>
Date: Tue, 11 Feb 2025 11:55:52 +0100
Subject: [PATCH] os: io: improve some docs on discarding fd's passed along w/
 request

It's a non-trivial topic that's deserving a bit more explainations.

Signed-off-by: Enrico Weigelt, metux IT consult <info@metux.net>
---
 os/io.c | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/os/io.c b/os/io.c
index b0c314a4d..e529f489e 100644
--- a/os/io.c
+++ b/os/io.c
@@ -253,7 +253,10 @@ ReadRequestFromClient(ClientPtr client)
     }
 
 #if XTRANS_SEND_FDS
-    /* Discard any unused file descriptors */
+    /* Discard any unused file descriptors:
+       those which are claimed to exist via SetReqFds(), but haven't been
+       consumed by the request handler via ReadFdFromClient()
+    */
     while (client->req_fds > 0) {
         int req_fd = ReadFdFromClient(client);
         if (req_fd >= 0)