summaryrefslogtreecommitdiffstats
path: root/doc/Thread.3
diff options
context:
space:
mode:
authordkf <donal.k.fellows@manchester.ac.uk>2018-09-28 09:49:57 (GMT)
committerdkf <donal.k.fellows@manchester.ac.uk>2018-09-28 09:49:57 (GMT)
commiteede8c60a140b1ebb3eb6a795ecc703e89f466f4 (patch)
treeb438a901c94afd9d821eeeabab6da92f60ee944f /doc/Thread.3
parent9dabbdf40b10e3f0419d5ad5b96f4d7c3189bc6a (diff)
downloadtcl-eede8c60a140b1ebb3eb6a795ecc703e89f466f4.zip
tcl-eede8c60a140b1ebb3eb6a795ecc703e89f466f4.tar.gz
tcl-eede8c60a140b1ebb3eb6a795ecc703e89f466f4.tar.bz2
Clean up code style and add key phrases to documentation.
Diffstat (limited to 'doc/Thread.3')
-rw-r--r--doc/Thread.310
1 files changed, 8 insertions, 2 deletions
diff --git a/doc/Thread.3 b/doc/Thread.3
index 5966a71..59bf488 100644
--- a/doc/Thread.3
+++ b/doc/Thread.3
@@ -45,7 +45,9 @@ int
.AP Tcl_Condition *condPtr in
A condition variable, which must be associated with a mutex lock.
.AP Tcl_Mutex *mutexPtr in
-A mutex lock.
+.VS TIP509
+A recursive mutex lock.
+.VE TIP509
.AP "const Tcl_Time" *timePtr in
A time limit on the condition wait. NULL to wait forever.
Note that a polling value of 0 seconds does not make much sense.
@@ -135,7 +137,11 @@ Tcl provides \fBTcl_ThreadQueueEvent\fR and \fBTcl_ThreadAlert\fR
for handling event queuing in multithreaded applications. See
the \fBNotifier\fR manual page for more information on these procedures.
.PP
-A mutex is a lock that is used to serialize all threads through a piece
+A mutex is a
+.VS TIP509
+recursive
+.VE TIP509
+lock that is used to serialize all threads through a piece
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.