git: 5544391d8724 - stable/13 - sleepqueue: Fix the comment for sleepq_switch()

From: Mark Johnston <markj_at_FreeBSD.org>
Date: Tue, 19 Nov 2024 14:31:26 UTC
The branch stable/13 has been updated by markj:

URL: https://cgit.FreeBSD.org/src/commit/?id=5544391d872495b5517ac16ce9a46027925efc1a

commit 5544391d872495b5517ac16ce9a46027925efc1a
Author:     Mark Johnston <markj@FreeBSD.org>
AuthorDate: 2024-11-12 01:57:24 +0000
Commit:     Mark Johnston <markj@FreeBSD.org>
CommitDate: 2024-11-19 14:15:15 +0000

    sleepqueue: Fix the comment for sleepq_switch()
    
    The comment from mi_switch() applies here.
    
    PR:             279708
    Fixes:          686bcb5c14ab ("schedlock 4/4")
    MFC after:      1 week
    
    (cherry picked from commit 1030ee9128373e7819e5d4a45475ad8cda24fec9)
---
 sys/kern/subr_sleepqueue.c | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/sys/kern/subr_sleepqueue.c b/sys/kern/subr_sleepqueue.c
index d5308b1e929a..727e13891f98 100644
--- a/sys/kern/subr_sleepqueue.c
+++ b/sys/kern/subr_sleepqueue.c
@@ -539,7 +539,8 @@ sleepq_catch_signals(const void *wchan, int pri)
 
 /*
  * Switches to another thread if we are still asleep on a sleep queue.
- * Returns with thread lock.
+ *
+ * The thread lock is required on entry and is no longer held on return.
  */
 static void
 sleepq_switch(const void *wchan, int pri)