Debian Codegraph @

upstream/debian-unstable/man3/Test2::Tools::Warnings.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::Tools::Warnings 3perl"
58 .TH Test2::Tools::Warnings 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::Tools::Warnings \- Tools to verify warnings.
65 .SH DESCRIPTION
66 .IX Header "DESCRIPTION"
67 This is a collection of tools that can be used to test code that issues
68 warnings.
69 .SH SYNOPSIS
70 .IX Header "SYNOPSIS"
71 .Vb 1
72 \& use Test2::Tools::Warnings qw/warns warning warnings no_warnings/;
73 \&
74 \& ok(warns { warn \*(Aqa\*(Aq }, "the code warns");
75 \& ok(!warns { 1 }, "The code does not warn");
76 \& is(warns { warn \*(Aqa\*(Aq; warn \*(Aqb\*(Aq }, 2, "got 2 warnings");
77 \&
78 \& ok(no_warnings { ... }, "code did not warn");
79 \&
80 \& like(
81 \& warning { warn \*(Aqxxx\*(Aq },
82 \& qr/xxx/,
83 \& "Got expected warning"
84 \& );
85 \&
86 \& is(
87 \& warnings { warn "a\en"; warn "b\en" },
88 \& [
89 \& "a\en",
90 \& "b\en",
91 \& ],
92 \& "Got 2 specific warnings"
93 \& );
94 .Ve
95 .SH EXPORTS
96 .IX Header "EXPORTS"
97 All subs are exported by default.
98 .ie n .IP "$count = warns { ... }" 4
99 .el .IP "\f(CW$count\fR = warns { ... }" 4
100 .IX Item "$count = warns { ... }"
101 Returns the count of warnings produced by the block. This will always return 0,
102 or a positive integer.
103 .ie n .IP "$warning = warning { ... }" 4
104 .el .IP "\f(CW$warning\fR = warning { ... }" 4
105 .IX Item "$warning = warning { ... }"
106 Returns the first warning generated by the block. If the block produces more
107 than one warning, they will all be shown as notes, and an actual warning will tell
108 you about it.
109 .ie n .IP "$warnings_ref = warnings { ... }" 4
110 .el .IP "\f(CW$warnings_ref\fR = warnings { ... }" 4
111 .IX Item "$warnings_ref = warnings { ... }"
112 Returns an arrayref with all the warnings produced by the block. This will
113 always return an array reference. If there are no warnings, this will return an
114 empty array reference.
115 .ie n .IP "$bool = no_warnings { ... }" 4
116 .el .IP "\f(CW$bool\fR = no_warnings { ... }" 4
117 .IX Item "$bool = no_warnings { ... }"
118 Return true if the block has no warnings. Returns false if there are warnings.
119 .SH SOURCE
120 .IX Header "SOURCE"
121 The source code repository for Test2\-Suite can be found at
122 \&\fIhttps://github.com/Test\-More/Test2\-Suite/\fR.
123 .SH MAINTAINERS
124 .IX Header "MAINTAINERS"
125 .IP "Chad Granum <[email protected]>" 4
126 .IX Item "Chad Granum <[email protected]>"
127 .SH AUTHORS
128 .IX Header "AUTHORS"
129 .PD 0
130 .IP "Chad Granum <[email protected]>" 4
131 .IX Item "Chad Granum <[email protected]>"
132 .PD
133 .SH COPYRIGHT
134 .IX Header "COPYRIGHT"
135 Copyright 2018 Chad Granum <[email protected]>.
136 .PP
137 This program is free software; you can redistribute it and/or
138 modify it under the same terms as Perl itself.
139 .PP
140 See \fIhttp://dev.perl.org/licenses/\fR