Debian Codegraph @

upstream/debian-unstable/man3/Test2::Plugin::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::Plugin::Times 3perl"
58 .TH Test2::Plugin::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::Plugin::Times \- Output timing data at the end of the test.
65 .SH CAVEAT
66 .IX Header "CAVEAT"
67 It is important to note that this timing data does not include global
68 destruction. This data is only collected up until the point \fBdone_testing()\fR is
69 called. If your program takes time for END blocks, garbage collection, and
70 similar, then this timing data will fall short of reality.
71 .SH DESCRIPTION
72 .IX Header "DESCRIPTION"
73 This plugin will output a diagnostics message at the end of testing that tells
74 you how much time elapsed, and how hard the system worked on the test.
75 .PP
76 This will produce a string like one of these (Note these numbers are completely
77 made up). \fIWhich string is used depends on the time elapsed.\fR
78 .PP
79 .Vb 1
80 \& 0.12345s on wallclock (0.05 usr 0.00 sys + 0.00 cusr 0.00 csys = 0.05 CPU)
81 \&
82 \& 11.1234s on wallclock (0.05 usr 0.00 sys + 0.00 cusr 0.00 csys = 0.05 CPU)
83 \&
84 \& 01m:54.45s on wallclock (0.05 usr 0.00 sys + 0.00 cusr 0.00 csys = 0.05 CPU)
85 \&
86 \& 18h:22m:54.45s on wallclock (0.05 usr 0.00 sys + 0.00 cusr 0.00 csys = 0.05 CPU)
87 \&
88 \& 04d:18h:22m:54.45s on wallclock (0.05 usr 0.00 sys + 0.00 cusr 0.00 csys = 0.05 CPU)
89 .Ve
90 .SH SYNOPSIS
91 .IX Header "SYNOPSIS"
92 .Vb 1
93 \& use Test2::Plugin::Times;
94 .Ve
95 .PP
96 This is also useful at the command line for 1\-time use:
97 .PP
98 .Vb 1
99 \& $ perl \-MTest2::Plugin::Times path/to/test.t
100 .Ve
101 .SH SOURCE
102 .IX Header "SOURCE"
103 The source code repository for Test2\-Suite can be found at
104 \&\fIhttps://github.com/Test\-More/Test2\-Suite/\fR.
105 .SH MAINTAINERS
106 .IX Header "MAINTAINERS"
107 .IP "Chad Granum <[email protected]>" 4
108 .IX Item "Chad Granum <[email protected]>"
109 .SH AUTHORS
110 .IX Header "AUTHORS"
111 .PD 0
112 .IP "Chad Granum <[email protected]>" 4
113 .IX Item "Chad Granum <[email protected]>"
114 .PD
115 .SH COPYRIGHT
116 .IX Header "COPYRIGHT"
117 Copyright 2018 Chad Granum <[email protected]>.
118 .PP
119 This program is free software; you can redistribute it and/or
120 modify it under the same terms as Perl itself.
121 .PP
122 See \fIhttp://dev.perl.org/licenses/\fR