Debian Codegraph @

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