Debian Codegraph @

upstream/opensuse-tumbleweed/man3/Test2::EventFacet::Plan.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::EventFacet::Plan 3pm"
61 .TH Test2::EventFacet::Plan 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::EventFacet::Plan \- Facet for setting the plan
68 .SH DESCRIPTION
69 .IX Header "DESCRIPTION"
70 Events use this facet when they need to set the plan.
71 .SH FIELDS
72 .IX Header "FIELDS"
73 .ie n .IP "$string = $plan\->{details}" 4
74 .el .IP "\f(CW$string\fR = \f(CW$plan\fR\->{details}" 4
75 .IX Item "$string = $plan->{details}"
76 .PD 0
77 .ie n .IP "$string = $plan\->\fBdetails()\fR" 4
78 .el .IP "\f(CW$string\fR = \f(CW$plan\fR\->\fBdetails()\fR" 4
79 .IX Item "$string = $plan->details()"
80 .PD
81 Human readable explanation for the plan being set. This is normally not
82 rendered by most formatters except when the \f(CW\*(C`skip\*(C'\fR field is also set.
83 .ie n .IP "$positive_int = $plan\->{count}" 4
84 .el .IP "\f(CW$positive_int\fR = \f(CW$plan\fR\->{count}" 4
85 .IX Item "$positive_int = $plan->{count}"
86 .PD 0
87 .ie n .IP "$positive_int = $plan\->\fBcount()\fR" 4
88 .el .IP "\f(CW$positive_int\fR = \f(CW$plan\fR\->\fBcount()\fR" 4
89 .IX Item "$positive_int = $plan->count()"
90 .PD
91 Set the number of expected assertions. This should usually be set to \f(CW0\fR when
92 \&\f(CW\*(C`skip\*(C'\fR or \f(CW\*(C`none\*(C'\fR are also set.
93 .ie n .IP "$bool = $plan\->{skip}" 4
94 .el .IP "\f(CW$bool\fR = \f(CW$plan\fR\->{skip}" 4
95 .IX Item "$bool = $plan->{skip}"
96 .PD 0
97 .ie n .IP "$bool = $plan\->\fBskip()\fR" 4
98 .el .IP "\f(CW$bool\fR = \f(CW$plan\fR\->\fBskip()\fR" 4
99 .IX Item "$bool = $plan->skip()"
100 .PD
101 When true the entire test should be skipped. This is usually paired with an
102 explanation in the \f(CW\*(C`details\*(C'\fR field, and a \f(CW\*(C`control\*(C'\fR facet that has
103 \&\f(CW\*(C`terminate\*(C'\fR set to \f(CW0\fR.
104 .ie n .IP "$bool = $plan\->{none}" 4
105 .el .IP "\f(CW$bool\fR = \f(CW$plan\fR\->{none}" 4
106 .IX Item "$bool = $plan->{none}"
107 .PD 0
108 .ie n .IP "$bool = $plan\->\fBnone()\fR" 4
109 .el .IP "\f(CW$bool\fR = \f(CW$plan\fR\->\fBnone()\fR" 4
110 .IX Item "$bool = $plan->none()"
111 .PD
112 This is mainly used by legacy Test::Builder tests which set the plan to \f(CW\*(C`no
113 plan\*(C'\fR, a construct that predates the much better \f(CWdone_testing()\fR.
114 .Sp
115 If you are using this in non\-legacy code you may need to reconsider the course
116 of your life, maybe a hermitage would suite you?
117 .SH SOURCE
118 .IX Header "SOURCE"
119 The source code repository for Test2 can be found at
120 <https://github.com/Test\-More/test\-more/>.
121 .SH MAINTAINERS
122 .IX Header "MAINTAINERS"
123 .IP "Chad Granum <[email protected]>" 4
124 .IX Item "Chad Granum <[email protected]>"
125 .SH AUTHORS
126 .IX Header "AUTHORS"
127 .IP "Chad Granum <[email protected]>" 4
128 .IX Item "Chad Granum <[email protected]>"
129 .SH COPYRIGHT
130 .IX Header "COPYRIGHT"
131 Copyright Chad Granum <[email protected]>.
132 .PP
133 This program is free software; you can redistribute it and/or
134 modify it under the same terms as Perl itself.
135 .PP
136 See <https://dev.perl.org/licenses/>