Debian Codegraph @

upstream/debian-unstable/man3/Test2::Bundle.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::Bundle 3perl"
58 .TH Test2::Bundle 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::Bundle \- Documentation for bundles.
65 .SH DESCRIPTION
66 .IX Header "DESCRIPTION"
67 Bundles are collections of Tools and Plugins. Bundles should not provide any
68 tools or behaviors of their own, they should simply combine the tools and
69 behaviors of other packages.
70 .SH FAQ
71 .IX Header "FAQ"
72 .IP "Should my bundle subclass Test2::Bundle?" 4
73 .IX Item "Should my bundle subclass Test2::Bundle?"
74 No. Currently this class is empty. Eventually we may want to add behavior, in
75 which case we do not want anyone to already be subclassing it.
76 .SH "HOW DO I WRITE A BUNDLE?"
77 .IX Header "HOW DO I WRITE A BUNDLE?"
78 Writing a bundle can be very simple:
79 .PP
80 .Vb 3
81 \& package Test2::Bundle::MyBundle;
82 \& use strict;
83 \& use warnings;
84 \&
85 \& use Test2::Plugin::ExitSummary; # Load a plugin
86 \&
87 \& use Test2::Tools::Basic qw/ok plan done_testing/;
88 \&
89 \& # Re\-export the tools
90 \& our @EXPORTS = qw/ok plan done_testing/;
91 \& use base \*(AqExporter\*(Aq;
92 \&
93 \& 1;
94 .Ve
95 .PP
96 If you want to do anything more complex you should look into Import::Into
97 and Symbol::Move.
98 .SH SOURCE
99 .IX Header "SOURCE"
100 The source code repository for Test2\-Suite can be found at
101 \&\fIhttps://github.com/Test\-More/Test2\-Suite/\fR.
102 .SH MAINTAINERS
103 .IX Header "MAINTAINERS"
104 .IP "Chad Granum <[email protected]>" 4
105 .IX Item "Chad Granum <[email protected]>"
106 .SH AUTHORS
107 .IX Header "AUTHORS"
108 .PD 0
109 .IP "Chad Granum <[email protected]>" 4
110 .IX Item "Chad Granum <[email protected]>"
111 .PD
112 .SH COPYRIGHT
113 .IX Header "COPYRIGHT"
114 Copyright 2018 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 \fIhttp://dev.perl.org/licenses/\fR