Debian Codegraph @

upstream/debian-unstable/man3/Test2::API::Breakage.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::API::Breakage 3perl"
58 .TH Test2::API::Breakage 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::API::Breakage \- What breaks at what version
65 .SH DESCRIPTION
66 .IX Header "DESCRIPTION"
67 This module provides lists of modules that are broken, or have been broken in
68 the past, when upgrading Test::Builder to use Test2.
69 .SH FUNCTIONS
70 .IX Header "FUNCTIONS"
71 These can be imported, or called as methods on the class.
72 .ie n .IP "%mod_ver = \fBupgrade_suggested()\fR" 4
73 .el .IP "\f(CW%mod_ver\fR = \fBupgrade_suggested()\fR" 4
74 .IX Item "%mod_ver = upgrade_suggested()"
75 .PD 0
76 .ie n .IP "%mod_ver = Test2::API::Breakage\->\fBupgrade_suggested()\fR" 4
77 .el .IP "\f(CW%mod_ver\fR = Test2::API::Breakage\->\fBupgrade_suggested()\fR" 4
78 .IX Item "%mod_ver = Test2::API::Breakage->upgrade_suggested()"
79 .PD
80 This returns key/value pairs. The key is the module name, the value is the
81 version number. If the installed version of the module is at or below the
82 specified one then an upgrade would be a good idea, but not strictly necessary.
83 .ie n .IP "%mod_ver = \fBupgrade_required()\fR" 4
84 .el .IP "\f(CW%mod_ver\fR = \fBupgrade_required()\fR" 4
85 .IX Item "%mod_ver = upgrade_required()"
86 .PD 0
87 .ie n .IP "%mod_ver = Test2::API::Breakage\->\fBupgrade_required()\fR" 4
88 .el .IP "\f(CW%mod_ver\fR = Test2::API::Breakage\->\fBupgrade_required()\fR" 4
89 .IX Item "%mod_ver = Test2::API::Breakage->upgrade_required()"
90 .PD
91 This returns key/value pairs. The key is the module name, the value is the
92 version number. If the installed version of the module is at or below the
93 specified one then an upgrade is required for the module to work properly.
94 .ie n .IP "%mod_ver = \fBknown_broken()\fR" 4
95 .el .IP "\f(CW%mod_ver\fR = \fBknown_broken()\fR" 4
96 .IX Item "%mod_ver = known_broken()"
97 .PD 0
98 .ie n .IP "%mod_ver = Test2::API::Breakage\->\fBknown_broken()\fR" 4
99 .el .IP "\f(CW%mod_ver\fR = Test2::API::Breakage\->\fBknown_broken()\fR" 4
100 .IX Item "%mod_ver = Test2::API::Breakage->known_broken()"
101 .PD
102 This returns key/value pairs. The key is the module name, the value is the
103 version number. If the installed version of the module is at or below the
104 specified one then the module will not work. A newer version may work, but is
105 not tested or verified.
106 .SH SOURCE
107 .IX Header "SOURCE"
108 The source code repository for Test2 can be found at
109 <https://github.com/Test\-More/test\-more/>.
110 .SH MAINTAINERS
111 .IX Header "MAINTAINERS"
112 .IP "Chad Granum <[email protected]>" 4
113 .IX Item "Chad Granum <[email protected]>"
114 .SH AUTHORS
115 .IX Header "AUTHORS"
116 .PD 0
117 .IP "Chad Granum <[email protected]>" 4
118 .IX Item "Chad Granum <[email protected]>"
119 .PD
120 .SH COPYRIGHT
121 .IX Header "COPYRIGHT"
122 Copyright 2020 Chad Granum <[email protected]>.
123 .PP
124 This program is free software; you can redistribute it and/or
125 modify it under the same terms as Perl itself.
126 .PP
127 See <https://dev.perl.org/licenses/>