Debian Codegraph @

upstream/opensuse-tumbleweed/man3/Test2::Util::Times.3pm

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\"
56 .\" Required to disable full justification in groff 1.23.0.
57 .if n .ds AD l
58 .\" ========================================================================
59 .\"
60 .IX Title "Test2::Util::Times 3pm"
61 .TH Test2::Util::Times 3pm 2026-03-09 "perl v5.42.1" "Perl Programmers Reference Guide"
62 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
63 .\" way too many mistakes in technical documents.
64 .if n .ad l
65 .nh
66 .SH NAME
67 Test2::Util::Times \- Format timing/benchmark information.
68 .SH DESCRIPTION
69 .IX Header "DESCRIPTION"
70 This modules exports tools for rendering timing data at the end of tests.
71 .SH EXPORTS
72 .IX Header "EXPORTS"
73 All exports are optional. You must specify subs to import.
74 .ie n .IP "$str = render_bench($start, $end, $user, $system, $cuser, $csystem)" 4
75 .el .IP "\f(CW$str\fR = render_bench($start, \f(CW$end\fR, \f(CW$user\fR, \f(CW$system\fR, \f(CW$cuser\fR, \f(CW$csystem\fR)" 4
76 .IX Item "$str = render_bench($start, $end, $user, $system, $cuser, $csystem)"
77 .PD 0
78 .ie n .IP "$str = render_bench($start, \fBtime()\fR, \fBtimes()\fR)" 4
79 .el .IP "\f(CW$str\fR = render_bench($start, \fBtime()\fR, \fBtimes()\fR)" 4
80 .IX Item "$str = render_bench($start, time(), times())"
81 .PD
82 This will produce a string like one of these (Note these numbers are completely
83 made up). \fIWhich string is used depends on the time elapsed.\fR
84 .Sp
85 .Vb 1
86 \& 0.12345s on wallclock (0.05 usr 0.00 sys + 0.00 cusr 0.00 csys = 0.05 CPU)
87 \&
88 \& 11.1234s on wallclock (0.05 usr 0.00 sys + 0.00 cusr 0.00 csys = 0.05 CPU)
89 \&
90 \& 01m:54.45s on wallclock (0.05 usr 0.00 sys + 0.00 cusr 0.00 csys = 0.05 CPU)
91 \&
92 \& 18h:22m:54.45s on wallclock (0.05 usr 0.00 sys + 0.00 cusr 0.00 csys = 0.05 CPU)
93 \&
94 \& 04d:18h:22m:54.45s on wallclock (0.05 usr 0.00 sys + 0.00 cusr 0.00 csys = 0.05 CPU)
95 .Ve
96 .Sp
97 The first 2 arguments are the \f(CW$start\fR and \f(CW$end\fR times in seconds (as
98 returned by \f(CWtime()\fR or \f(CWTime::HiRes::time()\fR).
99 .Sp
100 The last 4 arguments are timing information as returned by the \f(CWtimes()\fR
101 function.
102 .SH SOURCE
103 .IX Header "SOURCE"
104 The source code repository for Test2\-Suite can be found at
105 \&\fIhttps://github.com/Test\-More/test\-more/\fR.
106 .SH MAINTAINERS
107 .IX Header "MAINTAINERS"
108 .IP "Chad Granum <[email protected]>" 4
109 .IX Item "Chad Granum <[email protected]>"
110 .SH AUTHORS
111 .IX Header "AUTHORS"
112 .IP "Chad Granum <[email protected]>" 4
113 .IX Item "Chad Granum <[email protected]>"
114 .SH COPYRIGHT
115 .IX Header "COPYRIGHT"
116 Copyright Chad Granum <[email protected]>.
117 .PP
118 This program is free software; you can redistribute it and/or
119 modify it under the same terms as Perl itself.
120 .PP
121 See \fIhttp://dev.perl.org/licenses/\fR