diff options
Diffstat (limited to '')
| -rw-r--r-- | upstream/mageia-cauldron/man3pm/Test2::Event::Plan.3pm | 118 |
1 files changed, 118 insertions, 0 deletions
diff --git a/upstream/mageia-cauldron/man3pm/Test2::Event::Plan.3pm b/upstream/mageia-cauldron/man3pm/Test2::Event::Plan.3pm new file mode 100644 index 00000000..3c53c693 --- /dev/null +++ b/upstream/mageia-cauldron/man3pm/Test2::Event::Plan.3pm @@ -0,0 +1,118 @@ +.\" -*- mode: troff; coding: utf-8 -*- +.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43) +.\" +.\" Standard preamble: +.\" ======================================================================== +.de Sp \" Vertical space (when we can't use .PP) +.if t .sp .5v +.if n .sp +.. +.de Vb \" Begin verbatim text +.ft CW +.nf +.ne \\$1 +.. +.de Ve \" End verbatim text +.ft R +.fi +.. +.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. +.ie n \{\ +. ds C` "" +. ds C' "" +'br\} +.el\{\ +. ds C` +. ds C' +'br\} +.\" +.\" Escape single quotes in literal strings from groff's Unicode transform. +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" +.\" If the F register is >0, we'll generate index entries on stderr for +.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index +.\" entries marked with X<> in POD. Of course, you'll have to process the +.\" output yourself in some meaningful fashion. +.\" +.\" Avoid warning from groff about undefined register 'F'. +.de IX +.. +.nr rF 0 +.if \n(.g .if rF .nr rF 1 +.if (\n(rF:(\n(.g==0)) \{\ +. if \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" +.. +. if !\nF==2 \{\ +. nr % 0 +. nr F 2 +. \} +. \} +.\} +.rr rF +.\" ======================================================================== +.\" +.IX Title "Test2::Event::Plan 3pm" +.TH Test2::Event::Plan 3pm 2023-11-28 "perl v5.38.2" "Perl Programmers Reference Guide" +.\" For nroff, turn off justification. Always turn off hyphenation; it makes +.\" way too many mistakes in technical documents. +.if n .ad l +.nh +.SH NAME +Test2::Event::Plan \- The event of a plan +.SH DESCRIPTION +.IX Header "DESCRIPTION" +Plan events are fired off whenever a plan is declared, done testing is called, +or a subtext completes. +.SH SYNOPSIS +.IX Header "SYNOPSIS" +.Vb 2 +\& use Test2::API qw/context/; +\& use Test2::Event::Plan; +\& +\& my $ctx = context(); +\& +\& # Plan for 10 tests to run +\& my $event = $ctx\->plan(10); +\& +\& # Plan to skip all tests (will exit 0) +\& $ctx\->plan(0, skip_all => "These tests need to be skipped"); +.Ve +.SH ACCESSORS +.IX Header "ACCESSORS" +.ie n .IP "$num = $plan\->max" 4 +.el .IP "\f(CW$num\fR = \f(CW$plan\fR\->max" 4 +.IX Item "$num = $plan->max" +Get the number of expected tests +.ie n .IP "$dir = $plan\->directive" 4 +.el .IP "\f(CW$dir\fR = \f(CW$plan\fR\->directive" 4 +.IX Item "$dir = $plan->directive" +Get the directive (such as TODO, skip_all, or no_plan). +.ie n .IP "$reason = $plan\->reason" 4 +.el .IP "\f(CW$reason\fR = \f(CW$plan\fR\->reason" 4 +.IX Item "$reason = $plan->reason" +Get the reason for the directive. +.SH SOURCE +.IX Header "SOURCE" +The source code repository for Test2 can be found at +\&\fIhttp://github.com/Test\-More/test\-more/\fR. +.SH MAINTAINERS +.IX Header "MAINTAINERS" +.IP "Chad Granum <exodist@cpan.org>" 4 +.IX Item "Chad Granum <exodist@cpan.org>" +.SH AUTHORS +.IX Header "AUTHORS" +.PD 0 +.IP "Chad Granum <exodist@cpan.org>" 4 +.IX Item "Chad Granum <exodist@cpan.org>" +.PD +.SH COPYRIGHT +.IX Header "COPYRIGHT" +Copyright 2020 Chad Granum <exodist@cpan.org>. +.PP +This program is free software; you can redistribute it and/or +modify it under the same terms as Perl itself. +.PP +See \fIhttp://dev.perl.org/licenses/\fR |