diff options
author | jan.nijtmans <nijtmans@users.sourceforge.net> | 2017-06-02 08:12:38 (GMT) |
---|---|---|
committer | jan.nijtmans <nijtmans@users.sourceforge.net> | 2017-06-02 08:12:38 (GMT) |
commit | f00c9c9e4aa0c923528903a88e4bf2ef9aa6c2d5 (patch) | |
tree | 1601cdbe0f43c015bfcb743565108c36f488e67b /doc | |
parent | 1a543aa367940f7b7f4f8c6a8e83f673e2715611 (diff) | |
parent | 3ae95af52ca24414d723b827fc99cc1a2b94f778 (diff) | |
download | tcl-f00c9c9e4aa0c923528903a88e4bf2ef9aa6c2d5.zip tcl-f00c9c9e4aa0c923528903a88e4bf2ef9aa6c2d5.tar.gz tcl-f00c9c9e4aa0c923528903a88e4bf2ef9aa6c2d5.tar.bz2 |
Merge core-8-6-branch. This removes the work currently being done in "sebres-8-6-clock-speedup-cr1" branch, but that will be merged again as soon as the work is done.
All other changes in "trunk" since then (e.g. the INST_STR_CONCAT1 performance improvement, and the removal of SunOS-4) are retained.
Diffstat (limited to 'doc')
-rw-r--r-- | doc/clock.n | 39 | ||||
-rw-r--r-- | doc/timerate.n | 114 |
2 files changed, 2 insertions, 151 deletions
diff --git a/doc/clock.n b/doc/clock.n index dbe00ba..ac50e36 100644 --- a/doc/clock.n +++ b/doc/clock.n @@ -87,15 +87,6 @@ slowing its clock by a tiny fraction for some minutes until it is back in sync with UTC; its data model does not represent minutes that have 59 or 61 seconds. .TP -\fI\-now\fR -Instead of \fItimeVal\fR a non-integer option \fI\-now\fR can be used as -replacement for today, which is simply interpolated to the runt-time as value -of \fBclock seconds\fR. For example: -.sp -\fBclock format -now -f %a; # current day of the week\fR -.sp -\fBclock add -now 1 month; # next month\fR -.TP \fIunit\fR One of the words, \fBseconds\fR, \fBminutes\fR, \fBhours\fR, \fBdays\fR, \fBweekdays\fR, \fBweeks\fR, \fBmonths\fR, or \fByears\fR. @@ -536,12 +527,6 @@ abbreviation appropriate to the current locale, and uses it to fix whether \fB%Y\fR refers to years before or after Year 1 of the Common Era. .TP -\fB%Es\fR -This affects similar to \fB%s\fR, but in opposition to \fB%s\fR it parses -or formats local seconds (not the posix seconds). -Because \fB%s\fR has the same precedence as \fB%s\fR (uniquely determines -a point in time), it overrides all other input formats. -.TP \fB%Ex\fR On output, produces a locale-dependent representation of the date in the locale's alternative calendar. On input, matches @@ -736,15 +721,13 @@ week number \fB%V\fR; programs should use \fB%G\fR for that purpose. On output, produces the current time zone, expressed in hours and minutes east (+hhmm) or west (\-hhmm) of Greenwich. On input, accepts a time zone specifier (see \fBTIME ZONES\fR below) that will be used to -determine the time zone (this token is optionally applicable on input, -so the value is not mandatory and can be missing in input). +determine the time zone. .TP \fB%Z\fR On output, produces the current time zone's name, possibly translated to the given locale. On input, accepts a time zone specifier (see \fBTIME ZONES\fR below) that will be used to determine the -time zone (token is also like \fB%z\fR optionally applicable on input). -This option should, in general, be used on input only when +time zone. This option should, in general, be used on input only when parsing RFC822 dates. Other uses are fraught with ambiguity; for instance, the string \fBBST\fR may represent British Summer Time or Brazilian Standard Time. It is recommended that date/time strings for @@ -943,24 +926,6 @@ used. Finally, a correction is applied so that the correct hour of the day is produced after allowing for daylight savings time differences and the correct date is given when going from the end of a long month to a short month. -.PP -The precedence of the applying of single tokens resp. which sequence will be -used by calculating of the time is complex, e. g. heavily dependent on the -precision of type of the token. -.sp -In example below the second date-string contains "next January", therefore -it results in next year but in January. And third date-string besides "January" -contains also additionally "Fri", so it results in the nearest Friday. -Thus both win before "385 days" resp. make it more precise, because of higher -precision of this token types. -.CS -% clock format [clock scan "5 years 18 months 385 days" -base 0 -gmt 1] -gmt 1 -Thu Jul 21 00:00:00 GMT 1977 -% clock format [clock scan "5 years 18 months 385 days next January" -base 0 -gmt 1] -gmt 1 -Sat Jan 21 00:00:00 GMT 1978 -% clock format [clock scan "5 years 18 months 385 days next January Fri" -base 0 -gmt 1] -gmt 1 -Fri Jan 27 00:00:00 GMT 1978 -.CE .SH "SEE ALSO" msgcat(n) .SH KEYWORDS diff --git a/doc/timerate.n b/doc/timerate.n deleted file mode 100644 index df9a8f7..0000000 --- a/doc/timerate.n +++ /dev/null @@ -1,114 +0,0 @@ -'\" -'\" Copyright (c) 2005 Sergey Brester aka sebres. -'\" -'\" See the file "license.terms" for information on usage and redistribution -'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. -'\" -.TH timerate n "" Tcl "Tcl Built-In Commands" -.so man.macros -.BS -'\" Note: do not modify the .SH NAME line immediately below! -.SH NAME -timerate \- Time-related execution resp. performance measurement of a script -.SH SYNOPSIS -\fBtimerate \fIscript\fR \fI?time?\fR -.sp -\fBtimerate \fI?-direct?\fR \fI?-overhead double?\fR \fIscript\fR \fI?time?\fR -.sp -\fBtimerate \fI?-calibrate?\fR \fI?-direct?\fR \fIscript\fR \fI?time?\fR -.BE -.SH DESCRIPTION -.PP -The first and second form will evaluate \fIscript\fR until the interval -\fItime\fR given in milliseconds elapses, or for 1000 milliseconds (1 second) -if \fItime\fR is not specified. -.sp -It will then return a canonical tcl-list of the form -.PP -.CS -\f0.095977 µs/# 52095836 # 10419167 #/sec 5000.000 nett-ms\fR -.CE -.PP -which indicates: -.IP \(bu -the average amount of time required per iteration, in microseconds (lindex $result 0) -.IP \(bu -the count how many times it was executed (lindex $result 2) -.IP \(bu -the estimated rate per second (lindex $result 4) -.IP \(bu -the estimated real execution time without measurement overhead (lindex $result 6) -.PP -Time is measured in elapsed time using heighest timer resolution as possible, not CPU time. -This command may be used to provide information as to how well the script or a tcl-command -is performing and can help determine bottlenecks and fine-tune application performance. -.PP -\fI-calibrate\fR -. -To measure very fast scripts as exact as posible the calibration process -may be required. - -This parameter used to calibrate \fBtimerate\fR calculating the estimated overhead -of given \fIscript\fR as default overhead for further execution of \fBtimerate\fR. -It can take up to 10 seconds if parameter \fItime\fR is not specified. -.PP -\fI-overhead double\fR -. -This parameter used to supply the measurement overhead of single iteration -(in microseconds) that should be ignored during whole evaluation process. -.PP -\fI-direct\fR -. -Causes direct execution per iteration (not compiled variant of evaluation used). -.PP -In opposition to \fBtime\fR the execution limited here by fixed time instead of -repetition count. -Additionally the compiled variant of the script will be used during whole evaluation -(as if it were part of a compiled \fBproc\fR), if parameter \fI-direct\fR is not specified. -Therefore it provides more precise results and prevents very long execution time -by slow scripts resp. scripts with unknown speed. - -.SH EXAMPLE -Estimate how fast it takes for a simple Tcl \fBfor\fR loop (including -operations on variable \fIi\fR) to count to a ten: -.PP -.CS -# calibrate: -timerate -calibrate {} -# measure: -timerate { for {set i 0} {$i<10} {incr i} {} } 5000 -.CE -.PP -Estimate how fast it takes for a simple Tcl \fBfor\fR loop only (ignoring the -overhead for operations on variable \fIi\fR) to count to a ten: -.PP -.CS -# calibrate for overhead of variable operations: -set i 0; timerate -calibrate {expr {$i<10}; incr i} 1000 -# measure: -timerate { for {set i 0} {$i<10} {incr i} {} } 5000 -.CE -.PP -Estimate the rate of calculating the hour using \fBclock format\fR only, ignoring -overhead of the rest, without measurement how fast it takes for a whole script: -.PP -.CS -# calibrate: -timerate -calibrate {} -# estimate overhead: -set tm 0 -set ovh [lindex [timerate { incr tm [expr {24*60*60}] }] 0] -# measure using esimated overhead: -set tm 0 -timerate -overhead $ovh { - clock format $tm -format %H - incr tm [expr {24*60*60}]; # overhead for this is ignored -} 5000 -.CE -.SH "SEE ALSO" -time(n) -.SH KEYWORDS -script, timerate, time -.\" Local Variables: -.\" mode: nroff -.\" End: |