Debian Codegraph @

upstream/opensuse-tumbleweed/man3/Test2::Plugin::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::Plugin::Times 3pm"
61 .TH Test2::Plugin::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::Plugin::Times \- Output timing data at the end of the test.
68 .SH CAVEAT
69 .IX Header "CAVEAT"
70 It is important to note that this timing data does not include global
71 destruction. This data is only collected up until the point \fBdone_testing()\fR is
72 called. If your program takes time for END blocks, garbage collection, and
73 similar, then this timing data will fall short of reality.
74 .SH DESCRIPTION
75 .IX Header "DESCRIPTION"
76 This plugin will output a diagnostics message at the end of testing that tells
77 you how much time elapsed, and how hard the system worked on the test.
78 .PP
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 .PP
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 .SH SYNOPSIS
94 .IX Header "SYNOPSIS"
95 .Vb 1
96 \& use Test2::Plugin::Times;
97 .Ve
98 .PP
99 This is also useful at the command line for 1\-time use:
100 .PP
101 .Vb 1
102 \& $ perl \-MTest2::Plugin::Times path/to/test.t
103 .Ve
104 .SH SOURCE
105 .IX Header "SOURCE"
106 The source code repository for Test2\-Suite can be found at
107 \&\fIhttps://github.com/Test\-More/test\-more/\fR.
108 .SH MAINTAINERS
109 .IX Header "MAINTAINERS"
110 .IP "Chad Granum <[email protected]>" 4
111 .IX Item "Chad Granum <[email protected]>"
112 .SH AUTHORS
113 .IX Header "AUTHORS"
114 .IP "Chad Granum <[email protected]>" 4
115 .IX Item "Chad Granum <[email protected]>"
116 .SH COPYRIGHT
117 .IX Header "COPYRIGHT"
118 Copyright Chad Granum <[email protected]>.
119 .PP
120 This program is free software; you can redistribute it and/or
121 modify it under the same terms as Perl itself.
122 .PP
123 See \fIhttp://dev.perl.org/licenses/\fR