[Guile-commits] 05/06: Document wait-condition-variable's spurious returns

[Andy Wingo]

wingo pushed a commit to branch main
in repository guile.

commit 0a8a1eb595663e6eba3583f988e1d81025ff5dd4
Author: Rob Browning <rlb@defaultvalue.org>
AuthorDate: Sun Feb 25 13:45:14 2024 -0600

    Document wait-condition-variable's spurious returns
---
 libguile/threads.c | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

diff --git a/libguile/threads.c b/libguile/threads.c
index bdc4f3415..e7c6787f1 100644
--- a/libguile/threads.c
+++ b/libguile/threads.c
@@ -1398,9 +1398,10 @@ SCM_DEFINE (scm_timed_wait_condition_variable, 
"wait-condition-variable", 2, 1,
 "it specifies a point in time where the waiting should be aborted.  It "
 "can be either a integer as returned by @code{current-time} or a pair "
 "as returned by @code{gettimeofday}.  When the waiting is aborted the "
-"mutex is locked and @code{#f} is returned.  When the condition "
-"variable is in fact signaled, the mutex is also locked and @code{#t} "
-"is returned. ")
+"mutex is locked and @code{#f} is returned.  After the condition "
+"variable is signaled, the mutex is locked and @code{#t} is returned.  "
+"@code{#t} may also be returned spuriously, so any relevant conditions "
+"should be re-checked.")
 #define FUNC_NAME s_scm_timed_wait_condition_variable
 {
   scm_t_timespec waittime_val, *waittime = NULL;