summaryrefslogtreecommitdiff
path: root/doc/lispref
diff options
context:
space:
mode:
authorNoam Postavsky <npostavs@gmail.com>2016-12-12 21:21:14 -0500
committerNoam Postavsky <npostavs@gmail.com>2016-12-12 21:21:14 -0500
commitc78f872a5667abacb3531edd9aad969af31a3e1f (patch)
treec041fe8c70f8f770c4daf95d0bce19062ae03898 /doc/lispref
parentf66174a1b7f8e87e699ecf629563244782291148 (diff)
downloademacs-c78f872a5667abacb3531edd9aad969af31a3e1f.tar.gz
Clarify thread-signal semantics
* doc/lispref/threads.texi (Basic Thread Functions): Explain that the thread will be signaled as soon as possible.
Diffstat (limited to 'doc/lispref')
-rw-r--r--doc/lispref/threads.texi8
1 files changed, 5 insertions, 3 deletions
diff --git a/doc/lispref/threads.texi b/doc/lispref/threads.texi
index 7ecfb194044..de1c27bf186 100644
--- a/doc/lispref/threads.texi
+++ b/doc/lispref/threads.texi
@@ -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