1
Fork 0
mirror of https://git.savannah.gnu.org/git/guile.git synced 2025-04-29 19:30:36 +02:00

Document wait-condition-variable's spurious returns

This commit is contained in:
Rob Browning 2024-02-25 13:45:14 -06:00 committed by Andy Wingo
parent 2a4c095f79
commit 0a8a1eb595

View file

@ -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;