summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJoe Mistachkin <joe@mistachkin.com>2015-05-16 06:59:27 (GMT)
committerJoe Mistachkin <joe@mistachkin.com>2015-05-16 06:59:27 (GMT)
commitb96efa9cbb68cfff7b6df11f8905b5719eaf7570 (patch)
tree91a36b68270410037ab27326db161304d19856dd
parentb498f654dd231ff31232ffb06c29f9570aa292f5 (diff)
downloadtcl-b96efa9cbb68cfff7b6df11f8905b5719eaf7570.zip
tcl-b96efa9cbb68cfff7b6df11f8905b5719eaf7570.tar.gz
tcl-b96efa9cbb68cfff7b6df11f8905b5719eaf7570.tar.bz2
Reword and clarify the doc changes from the previous check-in.
-rw-r--r--doc/Thread.37
1 files changed, 4 insertions, 3 deletions
diff --git a/doc/Thread.3 b/doc/Thread.3
index ce449ba..c84dcb4 100644
--- a/doc/Thread.3
+++ b/doc/Thread.3
@@ -142,9 +142,10 @@ of code by calling \fBTcl_MutexLock\fR and \fBTcl_MutexUnlock\fR.
If one thread holds a mutex, any other thread calling \fBTcl_MutexLock\fR will
block until \fBTcl_MutexUnlock\fR is called.
A mutex can be destroyed after its use by calling \fBTcl_MutexFinalize\fR or
-\fBTcl_MutexUnlockAndFinalize\fR. It is illegal to destroy a locked mutex
-with \fBTcl_MutexFinalize\fR; however, it is legal to destroy a locked mutex
-with \fBTcl_MutexUnlockAndFinalize\fR.
+\fBTcl_MutexUnlockAndFinalize\fR. The \fBTcl_MutexFinalize\fR function may
+only be used on unlocked mutexes; otherwise, its behavior is undefined. The
+\fBTcl_MutexUnlockAndFinalize\fR function may only be used on locked mutexes;
+otherwise, its behavior is undefined.
The result of locking a mutex twice from the same thread is undefined.
On some platforms it will result in a deadlock.
The \fBTcl_MutexLock\fR, \fBTcl_MutexUnlock\fR, \fBTcl_MutexFinalize\fR, and