From: Noam Postavsky <npostavs@gmail.com>
Date: Tue, 13 Dec 2016 02:21:14 +0000 (-0500)
Subject: Clarify thread-signal semantics
X-Git-Tag: emacs-26.0.90~1115
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=c78f872a5667abacb3531edd9aad969af31a3e1f;p=emacs.git

Clarify thread-signal semantics

* doc/lispref/threads.texi (Basic Thread Functions): Explain that the
thread will be signaled as soon as possible.
---

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