summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorgahr <gahr@gahr.ch>2016-05-04 12:23:40 (GMT)
committergahr <gahr@gahr.ch>2016-05-04 12:23:40 (GMT)
commitbcaca1bf7b9159ba02add2f07ddff74fc872093f (patch)
tree22be59bbefedc6af251b1ba81b964ab787547b5a
parentdf18ecdce0832c7722af0396d30c814d1cebe3a3 (diff)
downloadtcl-bcaca1bf7b9159ba02add2f07ddff74fc872093f.zip
tcl-bcaca1bf7b9159ba02add2f07ddff74fc872093f.tar.gz
tcl-bcaca1bf7b9159ba02add2f07ddff74fc872093f.tar.bz2
Add a note in tcltest manual page to betray false expectations on msec and usec.
-rw-r--r--doc/tcltest.n6
1 files changed, 6 insertions, 0 deletions
diff --git a/doc/tcltest.n b/doc/tcltest.n
index ac8b73b..05c1922 100644
--- a/doc/tcltest.n
+++ b/doc/tcltest.n
@@ -895,6 +895,12 @@ Print each test's execution time in milliseconds
.IP "usec (\fBu\fR)"
Print each test's execution time in microseconds
.PP
+Note that the \fBmsec\fR and \fBusec\fR verbosity levels are provided as
+indicative measures only. They do not tackle the problem of repeatibility which
+should be considered in performance tests or benchmarks. To use these verbosity
+levels to thoroughly track performance degradations, consider wrapping your
+test bodies with \fBtime\fR commands.
+.PP
The single letter abbreviations noted above are also recognized
so that
.QW "\fBconfigure \-verbose pt\fR"