summaryrefslogtreecommitdiffstats
path: root/upstream/debian-bookworm/man3/Test2::API::Breakage.3perl
blob: 60e3fc019ff3c9026009f9b4a89e1af8e91b3aa2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
.\" Automatically generated by Pod::Man 4.14 (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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    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::API::Breakage 3perl"
.TH Test2::API::Breakage 3perl "2023-11-25" "perl v5.36.0" "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::API::Breakage \- What breaks at what version
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module provides lists of modules that are broken, or have been broken in
the past, when upgrading Test::Builder to use Test2.
.SH "FUNCTIONS"
.IX Header "FUNCTIONS"
These can be imported, or called as methods on the class.
.ie n .IP "%mod_ver = \fBupgrade_suggested()\fR" 4
.el .IP "\f(CW%mod_ver\fR = \fBupgrade_suggested()\fR" 4
.IX Item "%mod_ver = upgrade_suggested()"
.PD 0
.ie n .IP "%mod_ver = Test2::API::Breakage\->\fBupgrade_suggested()\fR" 4
.el .IP "\f(CW%mod_ver\fR = Test2::API::Breakage\->\fBupgrade_suggested()\fR" 4
.IX Item "%mod_ver = Test2::API::Breakage->upgrade_suggested()"
.PD
This returns key/value pairs. The key is the module name, the value is the
version number. If the installed version of the module is at or below the
specified one then an upgrade would be a good idea, but not strictly necessary.
.ie n .IP "%mod_ver = \fBupgrade_required()\fR" 4
.el .IP "\f(CW%mod_ver\fR = \fBupgrade_required()\fR" 4
.IX Item "%mod_ver = upgrade_required()"
.PD 0
.ie n .IP "%mod_ver = Test2::API::Breakage\->\fBupgrade_required()\fR" 4
.el .IP "\f(CW%mod_ver\fR = Test2::API::Breakage\->\fBupgrade_required()\fR" 4
.IX Item "%mod_ver = Test2::API::Breakage->upgrade_required()"
.PD
This returns key/value pairs. The key is the module name, the value is the
version number. If the installed version of the module is at or below the
specified one then an upgrade is required for the module to work properly.
.ie n .IP "%mod_ver = \fBknown_broken()\fR" 4
.el .IP "\f(CW%mod_ver\fR = \fBknown_broken()\fR" 4
.IX Item "%mod_ver = known_broken()"
.PD 0
.ie n .IP "%mod_ver = Test2::API::Breakage\->\fBknown_broken()\fR" 4
.el .IP "\f(CW%mod_ver\fR = Test2::API::Breakage\->\fBknown_broken()\fR" 4
.IX Item "%mod_ver = Test2::API::Breakage->known_broken()"
.PD
This returns key/value pairs. The key is the module name, the value is the
version number. If the installed version of the module is at or below the
specified one then the module will not work. A newer version may work, but is
not tested or verified.
.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