Debian Codegraph @

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