summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authordkf <donal.k.fellows@manchester.ac.uk>2004-12-09 09:24:38 (GMT)
committerdkf <donal.k.fellows@manchester.ac.uk>2004-12-09 09:24:38 (GMT)
commit77356c1235926a71096b61efdb3c11b6883384f0 (patch)
tree4a1699a843e47978754fa75b2d091687f8b4585f
parent924fb48b4b8a438e925a6c13abbce2953e6dc75d (diff)
downloadtcl-77356c1235926a71096b61efdb3c11b6883384f0.zip
tcl-77356c1235926a71096b61efdb3c11b6883384f0.tar.gz
tcl-77356c1235926a71096b61efdb3c11b6883384f0.tar.bz2
Minor doc fixes
-rw-r--r--ChangeLog5
-rw-r--r--doc/Async.318
2 files changed, 14 insertions, 9 deletions
diff --git a/ChangeLog b/ChangeLog
index d8bf2d2..32de98c 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@
+2004-12-09 Donal K. Fellows <donal.k.fellows@man.ac.uk>
+
+ * doc/Async.3: Reword for better grammar, better nroff and get the
+ flag name right. (Reported by David Welton.)
+
2004-12-06 Jeff Hobbs <jeffh@ActiveState.com>
*** 8.4.9 TAGGED FOR RELEASE ***
diff --git a/doc/Async.3 b/doc/Async.3
index 60fdad4..59ea687 100644
--- a/doc/Async.3
+++ b/doc/Async.3
@@ -5,7 +5,7 @@
'\" See the file "license.terms" for information on usage and redistribution
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
'\"
-'\" RCS: @(#) $Id: Async.3,v 1.5 2000/07/26 01:29:00 davidg Exp $
+'\" RCS: @(#) $Id: Async.3,v 1.5.18.1 2004/12/09 09:24:54 dkf Exp $
'\"
.so man.macros
.TH Tcl_AsyncCreate 3 7.0 Tcl "Tcl Library Procedures"
@@ -62,11 +62,11 @@ to a clean state, such as after the current Tcl command completes.
.PP
\fBTcl_AsyncCreate\fR, \fBTcl_AsyncDelete\fR, and \fBTcl_AsyncReady\fR
are thread sensitive. They access and/or set a thread-specific data
-structure in the event of an --enable-thread built core. The token
-created by Tcl_AsyncCreate contains the needed thread information it
-was called from so that calling Tcl_AsyncMark(token) will only yield
-the origin thread into the AsyncProc.
-.PP
+structure in the event of a core built with \fI\-\-enable\-threads\fR. The token
+created by \fBTcl_AsyncCreate\fR contains the needed thread information it
+was called from so that calling \fBTcl_AsyncMark\fR(\fItoken\fR) will only yield
+the origin thread into the asynchronous handler.
+.PP
\fBTcl_AsyncCreate\fR creates an asynchronous handler and returns
a token for it.
The asynchronous handler must be created before
@@ -85,9 +85,9 @@ the actions associated with the asynchronous event.
type \fBTcl_AsyncProc\fR:
.CS
typedef int Tcl_AsyncProc(
- ClientData \fIclientData\fR,
- Tcl_Interp *\fIinterp\fR,
- int \fIcode\fR);
+ ClientData \fIclientData\fR,
+ Tcl_Interp *\fIinterp\fR,
+ int \fIcode\fR);
.CE
The \fIclientData\fR will be the same as the \fIclientData\fR
argument passed to \fBTcl_AsyncCreate\fR when the handler was