.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Test2::Util::Times 3"
.TH Test2::Util::Times 3 2024-05-12 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Test2::Util::Times \- Format timing/benchmark information.
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This modules exports tools for rendering timing data at the end of tests.
.SH EXPORTS
.IX Header "EXPORTS"
All exports are optional. You must specify subs to import.
.ie n .IP "$str = render_bench($start, $end, $user, $system, $cuser, $csystem)" 4
.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
.IX Item "$str = render_bench($start, $end, $user, $system, $cuser, $csystem)"
.PD 0
.ie n .IP "$str = render_bench($start, \fBtime()\fR, \fBtimes()\fR)" 4
.el .IP "\f(CW$str\fR = render_bench($start, \fBtime()\fR, \fBtimes()\fR)" 4
.IX Item "$str = render_bench($start, time(), times())"
.PD
This will produce a string like one of these (Note these numbers are completely
made up). \fIWhich string is used depends on the time elapsed.\fR
.Sp
.Vb 1
\&    0.12345s on wallclock (0.05 usr 0.00 sys + 0.00 cusr 0.00 csys = 0.05 CPU)
\&
\&    11.1234s on wallclock (0.05 usr 0.00 sys + 0.00 cusr 0.00 csys = 0.05 CPU)
\&
\&    01m:54.45s on wallclock (0.05 usr 0.00 sys + 0.00 cusr 0.00 csys = 0.05 CPU)
\&
\&    18h:22m:54.45s on wallclock (0.05 usr 0.00 sys + 0.00 cusr 0.00 csys = 0.05 CPU)
\&
\&    04d:18h:22m:54.45s on wallclock (0.05 usr 0.00 sys + 0.00 cusr 0.00 csys = 0.05 CPU)
.Ve
.Sp
The first 2 arguments are the \f(CW$start\fR and \f(CW$end\fR times in seconds (as
returned by \f(CWtime()\fR or \f(CWTime::HiRes::time()\fR).
.Sp
The last 4 arguments are timing information as returned by the \f(CWtimes()\fR
function.
.SH SOURCE
.IX Header "SOURCE"
The source code repository for Test2\-Suite can be found at
\&\fIhttps://github.com/Test\-More/Test2\-Suite/\fR.
.SH MAINTAINERS
.IX Header "MAINTAINERS"
.IP "Chad Granum <exodist@cpan.org>" 4
.IX Item "Chad Granum <exodist@cpan.org>"
.SH AUTHORS
.IX Header "AUTHORS"
.PD 0
.IP "Chad Granum <exodist@cpan.org>" 4
.IX Item "Chad Granum <exodist@cpan.org>"
.PD
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright 2018 Chad Granum <exodist@cpan.org>.
.PP
This program is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.
.PP
See \fIhttp://dev.perl.org/licenses/\fR