.\" -*- 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::API::Breakage 3perl"
.TH Test2::API::Breakage 3perl 2024-02-11 "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::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