Fix [0c206e3a9b] - versions in manpages.

tcltk · Dec 8, 2024 · 21cdf69 · 21cdf69
1 parent aac1caf
commit 21cdf69
Show file tree

Hide file tree

Showing 12 changed files with 78 additions and 60 deletions.
diff --git a/doc/html/thread.html b/doc/html/thread.html
@@ -1,5 +1,6 @@
-
 <!DOCTYPE html><html><head>
+<meta charset="UTF-8">
+<meta name="viewport" content="width=device-width, initial-scale=1">
 <title>thread - Tcl Threading</title>
 <style type="text/css"><!--
     HTML {
@@ -97,7 +98,7 @@
 <!-- thread.n
    -->
 <body><div class="doctools">
-<h1 class="doctools_title">thread(n) 2.8  &quot;Tcl Threading&quot;</h1>
+<h1 class="doctools_title">thread(n) 3.0  &quot;Tcl Threading&quot;</h1>
 <div id="name" class="doctools_section"><h2><a name="name">Name</a></h2>
 <p>thread - Extension for script access to Tcl threading</p>
 </div>
@@ -115,8 +116,8 @@ <h1 class="doctools_title">thread(n) 2.8  &quot;Tcl Threading&quot;</h1>
 <div id="synopsis" class="doctools_section"><h2><a name="synopsis">Synopsis</a></h2>
 <div class="doctools_synopsis">
 <ul class="doctools_requirements">
-<li>package require <b class="pkgname">Tcl 8.7</b></li>
-<li>package require <b class="pkgname">thread <span class="opt">?2.9?</span></b></li>
+<li>package require <b class="pkgname">Tcl 9.0</b></li>
+<li>package require <b class="pkgname">thread <span class="opt">?3.0?</span></b></li>
 </ul>
 <ul class="doctools_syntax">
 <li><a href="#1"><b class="cmd">thread::create</b> <span class="opt">?-joinable?</span> <span class="opt">?-preserved?</span> <span class="opt">?script?</span></a></li>
@@ -363,7 +364,12 @@ <h1 class="doctools_title">thread(n) 2.8  &quot;Tcl Threading&quot;</h1>
 <dt><a name="12"><b class="cmd">thread::broadcast</b> <i class="arg">script</i></a></dt>
 <dd><p>This command passes a <i class="arg">script</i> to all threads created by the
 package for execution. It does not wait for response from any of
-the threads.</p></dd>
+the threads.</p>
+<p>The sending thread (the one executing the thread::broadcast command) does
+not send the script to itself.</p>
+<p>Each receiving thread is directed to place evaluation of the send script
+at the head of its event queue, stepping in front of any other events
+awaiting processing.</p></dd>
 <dt><a name="13"><b class="cmd">thread::wait</b></a></dt>
 <dd><p>This enters the event loop so a thread can receive messages from
 the <b class="cmd">thread::send</b> command. This command should only be used

diff --git a/doc/html/tpool.html b/doc/html/tpool.html
@@ -1,5 +1,6 @@
-
 <!DOCTYPE html><html><head>
+<meta charset="UTF-8">
+<meta name="viewport" content="width=device-width, initial-scale=1">
 <title>tpool - Tcl Threading</title>
 <style type="text/css"><!--
     HTML {
@@ -97,7 +98,7 @@
 <!-- tpool.n
    -->
 <body><div class="doctools">
-<h1 class="doctools_title">tpool(n) 2.8  &quot;Tcl Threading&quot;</h1>
+<h1 class="doctools_title">tpool(n) 3.0  &quot;Tcl Threading&quot;</h1>
 <div id="name" class="doctools_section"><h2><a name="name">Name</a></h2>
 <p>tpool - Part of the Tcl threading extension implementing pools of worker threads.</p>
 </div>
@@ -115,8 +116,8 @@ <h1 class="doctools_title">tpool(n) 2.8  &quot;Tcl Threading&quot;</h1>
 <div id="synopsis" class="doctools_section"><h2><a name="synopsis">Synopsis</a></h2>
 <div class="doctools_synopsis">
 <ul class="doctools_requirements">
-<li>package require <b class="pkgname">Tcl 8.7</b></li>
-<li>package require <b class="pkgname">thread <span class="opt">?2.9?</span></b></li>
+<li>package require <b class="pkgname">Tcl 9.0</b></li>
+<li>package require <b class="pkgname">thread <span class="opt">?3.0?</span></b></li>
 </ul>
 <ul class="doctools_syntax">
 <li><a href="#1"><b class="cmd">tpool::create</b> <span class="opt">?options?</span></a></li>
@@ -214,9 +215,9 @@ <h1 class="doctools_title">tpool(n) 2.8  &quot;Tcl Threading&quot;</h1>
 threads is equal to the maximum number of worker threads, as defined
 during the threadpool creation, the command will enter the event loop and
 service events while waiting for one of the worker threads to become idle.
-If the optional <span class="opt">?-nowait?</span> argument is given, the command will not wait
-for one idle worker. It will just place the job in the pool's job queue
-and return immediately.</p>
+If the optional <span class="opt">?-nowait?</span> argument is given, the command just places the
+job in the pool's job queue without waiting for an idle worker or creating a
+new one, even if the pool would still have room for additional threads.</p>
 <p>The command returns the ID of the posted job. This ID is used for subsequent
 <b class="cmd">tpool::wait</b>, <b class="cmd">tpool::get</b> and <b class="cmd">tpool::cancel</b> commands to wait
 for and retrieve result of the posted script, or cancel the posted job

diff --git a/doc/html/tsv.html b/doc/html/tsv.html
@@ -1,5 +1,6 @@
-
 <!DOCTYPE html><html><head>
+<meta charset="UTF-8">
+<meta name="viewport" content="width=device-width, initial-scale=1">
 <title>tsv - Tcl Threading</title>
 <style type="text/css"><!--
     HTML {
@@ -97,7 +98,7 @@
 <!-- tsv.n
    -->
 <body><div class="doctools">
-<h1 class="doctools_title">tsv(n) 2.8  &quot;Tcl Threading&quot;</h1>
+<h1 class="doctools_title">tsv(n) 3.0  &quot;Tcl Threading&quot;</h1>
 <div id="name" class="doctools_section"><h2><a name="name">Name</a></h2>
 <p>tsv - Part of the Tcl threading extension allowing script level manipulation of data shared between threads.</p>
 </div>
@@ -119,8 +120,8 @@ <h1 class="doctools_title">tsv(n) 2.8  &quot;Tcl Threading&quot;</h1>
 <div id="synopsis" class="doctools_section"><h2><a name="synopsis">Synopsis</a></h2>
 <div class="doctools_synopsis">
 <ul class="doctools_requirements">
-<li>package require <b class="pkgname">Tcl 8.7</b></li>
-<li>package require <b class="pkgname">thread <span class="opt">?2.9?</span></b></li>
+<li>package require <b class="pkgname">Tcl 9.0</b></li>
+<li>package require <b class="pkgname">thread <span class="opt">?3.0?</span></b></li>
 </ul>
 <ul class="doctools_syntax">
 <li><a href="#1"><b class="cmd">tsv::names</b> <span class="opt">?pattern?</span></a></li>

diff --git a/doc/html/ttrace.html b/doc/html/ttrace.html
@@ -1,5 +1,6 @@
-
 <!DOCTYPE html><html><head>
+<meta charset="UTF-8">
+<meta name="viewport" content="width=device-width, initial-scale=1">
 <title>ttrace - Tcl Threading</title>
 <style type="text/css"><!--
     HTML {
@@ -97,7 +98,7 @@
 <!-- ttrace.n
    -->
 <body><div class="doctools">
-<h1 class="doctools_title">ttrace(n) 2.8  &quot;Tcl Threading&quot;</h1>
+<h1 class="doctools_title">ttrace(n) 3.0  &quot;Tcl Threading&quot;</h1>
 <div id="name" class="doctools_section"><h2><a name="name">Name</a></h2>
 <p>ttrace - Trace-based interpreter initialization</p>
 </div>
@@ -116,8 +117,8 @@ <h1 class="doctools_title">ttrace(n) 2.8  &quot;Tcl Threading&quot;</h1>
 <div id="synopsis" class="doctools_section"><h2><a name="synopsis">Synopsis</a></h2>
 <div class="doctools_synopsis">
 <ul class="doctools_requirements">
-<li>package require <b class="pkgname">Tcl 8.7</b></li>
-<li>package require <b class="pkgname">thread <span class="opt">?2.9?</span></b></li>
+<li>package require <b class="pkgname">Tcl 9.0</b></li>
+<li>package require <b class="pkgname">thread <span class="opt">?3.0?</span></b></li>
 </ul>
 <ul class="doctools_syntax">
 <li><a href="#1"><b class="cmd">ttrace::eval</b> <i class="arg">arg</i> <span class="opt">?arg ...?</span></a></li>
@@ -151,14 +152,14 @@ <h1 class="doctools_title">ttrace(n) 2.8  &quot;Tcl Threading&quot;</h1>
 <p>In a nutshell, a short sample illustrating the usage of the ttrace
 with the Tcl threading extension:</p>
 <pre class="doctools_example">
-    % package require Ttrace
-    2.8.1
-    % set t1 [thread::create {package require Ttrace; thread::wait}]
+    % package require ttrace
+    3.0.1
+    % set t1 [thread::create {package require ttrace; thread::wait}]
     tid0x1802800
     % ttrace::eval {proc test args {return test-[thread::id]}}
     % thread::send $t1 test
     test-tid0x1802800
-    % set t2 [thread::create {package require Ttrace; thread::wait}]
+    % set t2 [thread::create {package require ttrace; thread::wait}]
     tid0x1804000
     % thread::send $t2 test
     test-tid0x1804000

diff --git a/doc/man/thread.n b/doc/man/thread.n
@@ -1,7 +1,7 @@
 '\"
 '\" Generated from file '' by tcllib/doctools with format 'nroff'
 '\"
-.TH "thread" n 2\&.8  "Tcl Threading"
+.TH "thread" n 3\&.0  "Tcl Threading"
 .\" The -*- nroff -*- definitions below are for supplemental macros used
 .\" in Tcl/Tk manual entries.
 .\"
@@ -273,9 +273,9 @@ Database Class:	\\fB\\$3\\fR
 .SH NAME
 thread \- Extension for script access to Tcl threading
 .SH SYNOPSIS
-package require \fBTcl  8\&.5\fR
+package require \fBTcl 9\&.0\fR
 .sp
-package require \fBthread  ?2\&.9?\fR
+package require \fBthread ?3\&.0?\fR
 .sp
 \fBthread::create\fR ?-joinable? ?-preserved? ?script?
 .sp
@@ -362,10 +362,8 @@ and sending scripts to threads for evaluation\&.
 This command creates a thread that contains a Tcl interpreter\&.
 The Tcl interpreter either evaluates the optional \fBscript\fR, if
 specified, or it waits in the event loop for scripts that arrive via
-the \fBthread::send\fR command\&. Both of them would take place simultaneously
-with the return of command \fBthread::create\fR to the caller thread\&.
-Neither the caller is waiting for the finishing of optional \fBscript\fR,
-nor the result, if any, of the \fBscript\fR is returned to the caller\&.
+the \fBthread::send\fR command\&. The result, if any, of the
+optional \fBscript\fR is never returned to the caller\&.
 The result of \fBthread::create\fR is the ID of the thread\&. This is
 the opaque handle which identifies the newly created thread for
 all other package commands\&. The handle of the thread goes out of scope
@@ -589,6 +587,13 @@ thus being executed in the LIFO fashion\&.
 This command passes a \fIscript\fR to all threads created by the
 package for execution\&. It does not wait for response from any of
 the threads\&.
+.sp
+The sending thread (the one executing the thread::broadcast command) does
+not send the script to itself\&.
+.sp
+Each receiving thread is directed to place evaluation of the send script
+at the head of its event queue, stepping in front of any other events
+awaiting processing\&.
 .TP
 \fBthread::wait\fR
 This enters the event loop so a thread can receive messages from
@@ -861,3 +866,4 @@ is also supported\&.
 \fIhttp://www\&.tcl\&.tk/doc/howto/thread_model\&.html\fR, tpool, tsv, ttrace
 .SH KEYWORDS
 events, message passing, mutex, synchronization, thread
+
diff --git a/doc/man/tpool.n b/doc/man/tpool.n
@@ -1,7 +1,7 @@
 '\"
 '\" Generated from file '' by tcllib/doctools with format 'nroff'
 '\"
-.TH "tpool" n 2\&.8  "Tcl Threading"
+.TH "tpool" n 3\&.0  "Tcl Threading"
 .\" The -*- nroff -*- definitions below are for supplemental macros used
 .\" in Tcl/Tk manual entries.
 .\"
@@ -273,9 +273,9 @@ Database Class:	\\fB\\$3\\fR
 .SH NAME
 tpool \- Part of the Tcl threading extension implementing pools of worker threads\&.
 .SH SYNOPSIS
-package require \fBTcl  8\&.5\fR
+package require \fBTcl 9\&.0\fR
 .sp
-package require \fBthread  ?2\&.9?\fR
+package require \fBthread ?3\&.0?\fR
 .sp
 \fBtpool::create\fR ?options?
 .sp
@@ -389,9 +389,9 @@ newly created thread is initialized\&. If the current number of worker
 threads is equal to the maximum number of worker threads, as defined
 during the threadpool creation, the command will enter the event loop and
 service events while waiting for one of the worker threads to become idle\&.
-If the optional ?-nowait? argument is given, the command will not wait
-for one idle worker\&. It will just place the job in the pool's job queue
-and return immediately\&.
+If the optional ?-nowait? argument is given, the command just places the
+job in the pool's job queue without waiting for an idle worker or creating a
+new one, even if the pool would still have room for additional threads\&.
 .sp
 The command returns the ID of the posted job\&. This ID is used for subsequent
 \fBtpool::wait\fR, \fBtpool::get\fR and \fBtpool::cancel\fR commands to wait
@@ -494,3 +494,4 @@ by forcing any request to wait until a thread is available to process it\&.
 thread, tsv, ttrace
 .SH KEYWORDS
 thread, threadpool
+
diff --git a/doc/man/tsv.n b/doc/man/tsv.n
@@ -1,7 +1,7 @@
 '\"
 '\" Generated from file '' by tcllib/doctools with format 'nroff'
 '\"
-.TH "tsv" n 2\&.8  "Tcl Threading"
+.TH "tsv" n 3\&.0  "Tcl Threading"
 .\" The -*- nroff -*- definitions below are for supplemental macros used
 .\" in Tcl/Tk manual entries.
 .\"
@@ -273,9 +273,9 @@ Database Class:	\\fB\\$3\\fR
 .SH NAME
 tsv \- Part of the Tcl threading extension allowing script level manipulation of data shared between threads\&.
 .SH SYNOPSIS
-package require \fBTcl  8\&.5\fR
+package require \fBTcl 9\&.0\fR
 .sp
-package require \fBthread  ?2\&.9?\fR
+package require \fBthread ?3\&.0?\fR
 .sp
 \fBtsv::names\fR ?pattern?
 .sp
@@ -626,3 +626,4 @@ AOLserver, a highly scalable Web server from America Online\&.
 thread, tpool, ttrace
 .SH KEYWORDS
 locking, synchronization, thread shared data, threads
+
diff --git a/doc/man/ttrace.n b/doc/man/ttrace.n
@@ -1,7 +1,7 @@
 '\"
 '\" Generated from file '' by tcllib/doctools with format 'nroff'
 '\"
-.TH "ttrace" n 2\&.8  "Tcl Threading"
+.TH "ttrace" n 3\&.0  "Tcl Threading"
 .\" The -*- nroff -*- definitions below are for supplemental macros used
 .\" in Tcl/Tk manual entries.
 .\"
@@ -273,9 +273,9 @@ Database Class:	\\fB\\$3\\fR
 .SH NAME
 ttrace \- Trace-based interpreter initialization
 .SH SYNOPSIS
-package require \fBTcl  8\&.5\fR
+package require \fBTcl 9\&.0\fR
 .sp
-package require \fBthread  ?2\&.9?\fR
+package require \fBthread ?3\&.0?\fR
 .sp
 \fBttrace::eval\fR \fIarg\fR ?arg \&.\&.\&.?
 .sp
@@ -328,17 +328,17 @@ with the Tcl threading extension:
 
 
 
-    % package require Ttrace
-    2\&.8\&.2
+    % package require ttrace
+    3\&.0\&.1
 
-    % set t1 [thread::create {package require Ttrace; thread::wait}]
+    % set t1 [thread::create {package require ttrace; thread::wait}]
     tid0x1802800
 
     % ttrace::eval {proc test args {return test-[thread::id]}}
     % thread::send $t1 test
     test-tid0x1802800
 
-    % set t2 [thread::create {package require Ttrace; thread::wait}]
+    % set t2 [thread::create {package require ttrace; thread::wait}]
     tid0x1804000
 
     % thread::send $t2 test
@@ -504,3 +504,4 @@ replicated from the master to other Tcl thread/interpreters\&.
 thread, tpool, tsv
 .SH KEYWORDS
 command tracing, introspection
+
diff --git a/doc/thread.man b/doc/thread.man
@@ -1,9 +1,9 @@
 [comment {-*- tcl -*- doctools manpage}]
-[manpage_begin thread n 2.8]
+[manpage_begin thread n 3.0]
 [moddesc {Tcl Threading}]
 [titledesc {Extension for script access to Tcl threading}]
-[require Tcl 8.7]
-[require thread [opt 2.8]]
+[require Tcl 9.0]
+[require thread [opt 3.0]]
 
 [description]
 The [package thread] extension creates threads that contain Tcl

diff --git a/doc/tpool.man b/doc/tpool.man
@@ -1,9 +1,9 @@
 [comment {-*- tcl -*- doctools manpage}]
-[manpage_begin tpool n 2.8]
+[manpage_begin tpool n 3.0]
 [moddesc {Tcl Threading}]
 [titledesc {Part of the Tcl threading extension implementing pools of worker threads.}]
-[require Tcl 8.7]
-[require thread [opt 2.8]]
+[require Tcl 9.0]
+[require thread [opt 3.0]]
 
 [description]
 This package creates and manages pools of worker threads. It allows you

diff --git a/doc/tsv.man b/doc/tsv.man
@@ -1,9 +1,9 @@
 [comment {-*- tcl -*- doctools manpage}]
-[manpage_begin tsv n 2.8]
+[manpage_begin tsv n 3.0]
 [moddesc {Tcl Threading}]
 [titledesc {Part of the Tcl threading extension allowing script level manipulation of data shared between threads.}]
-[require Tcl 8.7]
-[require thread [opt 2.8]]
+[require Tcl 9.0]
+[require thread [opt 3.0]]
 
 [description]
 This section describes commands implementing thread shared variables.

diff --git a/doc/ttrace.man b/doc/ttrace.man
@@ -1,9 +1,9 @@
 [comment {-*- tcl -*- doctools manpage}]
-[manpage_begin ttrace n 2.8]
+[manpage_begin ttrace n 3.0]
 [moddesc {Tcl Threading}]
 [titledesc {Trace-based interpreter initialization}]
-[require Tcl 8.7]
-[require thread [opt 2.8]]
+[require Tcl 9.0]
+[require thread [opt 3.0]]
 
 [description]
 This package creates a framework for on-demand replication of the
@@ -21,7 +21,7 @@ with the Tcl threading extension:
 [example {
 
     % package require ttrace
-    2.8.1
+    3.0.1
 
     % set t1 [thread::create {package require ttrace; thread::wait}]
     tid0x1802800