Debian Codegraph @

upstream/opensuse-tumbleweed/man3/Test2::Event::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::Event::Plan 3pm"
61 .TH Test2::Event::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::Event::Plan \- The event of a plan
68 .SH DESCRIPTION
69 .IX Header "DESCRIPTION"
70 Plan events are fired off whenever a plan is declared, done testing is called,
71 or a subtext completes.
72 .SH SYNOPSIS
73 .IX Header "SYNOPSIS"
74 .Vb 2
75 \& use Test2::API qw/context/;
76 \& use Test2::Event::Plan;
77 \&
78 \& my $ctx = context();
79 \&
80 \& # Plan for 10 tests to run
81 \& my $event = $ctx\->plan(10);
82 \&
83 \& # Plan to skip all tests (will exit 0)
84 \& $ctx\->plan(0, skip_all => "These tests need to be skipped");
85 .Ve
86 .SH ACCESSORS
87 .IX Header "ACCESSORS"
88 .ie n .IP "$num = $plan\->max" 4
89 .el .IP "\f(CW$num\fR = \f(CW$plan\fR\->max" 4
90 .IX Item "$num = $plan->max"
91 Get the number of expected tests
92 .ie n .IP "$dir = $plan\->directive" 4
93 .el .IP "\f(CW$dir\fR = \f(CW$plan\fR\->directive" 4
94 .IX Item "$dir = $plan->directive"
95 Get the directive (such as TODO, skip_all, or no_plan).
96 .ie n .IP "$reason = $plan\->reason" 4
97 .el .IP "\f(CW$reason\fR = \f(CW$plan\fR\->reason" 4
98 .IX Item "$reason = $plan->reason"
99 Get the reason for the directive.
100 .SH SOURCE
101 .IX Header "SOURCE"
102 The source code repository for Test2 can be found at
103 <https://github.com/Test\-More/test\-more/>.
104 .SH MAINTAINERS
105 .IX Header "MAINTAINERS"
106 .IP "Chad Granum <[email protected]>" 4
107 .IX Item "Chad Granum <[email protected]>"
108 .SH AUTHORS
109 .IX Header "AUTHORS"
110 .IP "Chad Granum <[email protected]>" 4
111 .IX Item "Chad Granum <[email protected]>"
112 .SH COPYRIGHT
113 .IX Header "COPYRIGHT"
114 Copyright Chad Granum <[email protected]>.
115 .PP
116 This program is free software; you can redistribute it and/or
117 modify it under the same terms as Perl itself.
118 .PP
119 See <https://dev.perl.org/licenses/>