Debian Codegraph @

upstream/debian-unstable/man3/Test2::Util::Times.3perl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (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 .\"
57 .IX Title "Test2::Util::Times 3perl"
58 .TH Test2::Util::Times 3perl 2025-11-16 "perl v5.40.1" "Perl Programmers Reference Guide"
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 Test2::Util::Times \- Format timing/benchmark information.
65 .SH DESCRIPTION
66 .IX Header "DESCRIPTION"
67 This modules exports tools for rendering timing data at the end of tests.
68 .SH EXPORTS
69 .IX Header "EXPORTS"
70 All exports are optional. You must specify subs to import.
71 .ie n .IP "$str = render_bench($start, $end, $user, $system, $cuser, $csystem)" 4
72 .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
73 .IX Item "$str = render_bench($start, $end, $user, $system, $cuser, $csystem)"
74 .PD 0
75 .ie n .IP "$str = render_bench($start, \fBtime()\fR, \fBtimes()\fR)" 4
76 .el .IP "\f(CW$str\fR = render_bench($start, \fBtime()\fR, \fBtimes()\fR)" 4
77 .IX Item "$str = render_bench($start, time(), times())"
78 .PD
79 This will produce a string like one of these (Note these numbers are completely
80 made up). \fIWhich string is used depends on the time elapsed.\fR
81 .Sp
82 .Vb 1
83 \& 0.12345s on wallclock (0.05 usr 0.00 sys + 0.00 cusr 0.00 csys = 0.05 CPU)
84 \&
85 \& 11.1234s on wallclock (0.05 usr 0.00 sys + 0.00 cusr 0.00 csys = 0.05 CPU)
86 \&
87 \& 01m:54.45s on wallclock (0.05 usr 0.00 sys + 0.00 cusr 0.00 csys = 0.05 CPU)
88 \&
89 \& 18h:22m:54.45s on wallclock (0.05 usr 0.00 sys + 0.00 cusr 0.00 csys = 0.05 CPU)
90 \&
91 \& 04d:18h:22m:54.45s on wallclock (0.05 usr 0.00 sys + 0.00 cusr 0.00 csys = 0.05 CPU)
92 .Ve
93 .Sp
94 The first 2 arguments are the \f(CW$start\fR and \f(CW$end\fR times in seconds (as
95 returned by \f(CWtime()\fR or \f(CWTime::HiRes::time()\fR).
96 .Sp
97 The last 4 arguments are timing information as returned by the \f(CWtimes()\fR
98 function.
99 .SH SOURCE
100 .IX Header "SOURCE"
101 The source code repository for Test2\-Suite can be found at
102 \&\fIhttps://github.com/Test\-More/Test2\-Suite/\fR.
103 .SH MAINTAINERS
104 .IX Header "MAINTAINERS"
105 .IP "Chad Granum <[email protected]>" 4
106 .IX Item "Chad Granum <[email protected]>"
107 .SH AUTHORS
108 .IX Header "AUTHORS"
109 .PD 0
110 .IP "Chad Granum <[email protected]>" 4
111 .IX Item "Chad Granum <[email protected]>"
112 .PD
113 .SH COPYRIGHT
114 .IX Header "COPYRIGHT"
115 Copyright 2018 Chad Granum <[email protected]>.
116 .PP
117 This program is free software; you can redistribute it and/or
118 modify it under the same terms as Perl itself.
119 .PP
120 See \fIhttp://dev.perl.org/licenses/\fR