Clarify thread-signal semantics

* doc/lispref/threads.texi (Basic Thread Functions): Explain that the
thread will be signaled as soon as possible.
This commit is contained in:
Noam Postavsky 2016-12-12 21:21:14 -05:00
parent f66174a1b7
commit c78f872a56

View file

@ -82,9 +82,11 @@ immediately.
@defun thread-signal thread error-symbol data
Like @code{signal} (@pxref{Signaling Errors}), but the signal is
delivered in the thread @var{thread}. If @var{thread} is the current
thread, then this just calls @code{signal} immediately.
@code{thread-signal} will cause a thread to exit a call to
@code{mutex-lock}, @code{condition-wait}, or @code{thread-join}.
thread, then this just calls @code{signal} immediately. Otherwise,
@var{thread} will receive the signal as soon as it becomes current.
If @var{thread} was blocked by a call to @code{mutex-lock},
@code{condition-wait}, or @code{thread-join}; @code{thread-signal}
will unblock it.
@end defun
@defun thread-yield