[dbsrgits/DBIx-Class.git] / lib / DBIx / Class / StartupCheck.pm

package DBIx::Class::StartupCheck;

use warnings;
use strict;

1;

__END__

=head1 NAME

DBIx::Class::StartupCheck - Run environment checks on startup

=head1 SYNOPSIS

  use DBIx::Class::StartupCheck;

=head1 DESCRIPTION

This module used to check for, and if necessary issue a warning for, a
particular bug found on Red Hat and Fedora systems using their system
perl build. As of September 2008 there are fixed versions of perl for
all current Red Hat and Fedora distributions, but the old check still
triggers, incorrectly flagging those versions of perl to be buggy. A
more comprehensive check has been moved into the test suite in
C<t/99rh_perl_perf_bug.t> and further information about the bug has been
put in L<DBIx::Class::Manual::Troubleshooting>.

Other checks may be added from time to time.

Any checks herein can be disabled by setting an appropriate environment
variable. If your system suffers from a particular bug, you will get a
warning message on startup sent to STDERR, explaining what to do about
it and how to suppress the message. If you don't see any messages, you
have nothing to worry about.

=head1 FURTHER QUESTIONS?

Check the list of L<additional DBIC resources|DBIx::Class/GETTING HELP/SUPPORT>.

=head1 COPYRIGHT AND LICENSE

This module is free software L<copyright|DBIx::Class/COPYRIGHT AND LICENSE>
by the L<DBIx::Class (DBIC) authors|DBIx::Class/AUTHORS>. You can
redistribute it and/or modify it under the same terms as the
L<DBIx::Class library|DBIx::Class/COPYRIGHT AND LICENSE>.
Commit	Line	Data
11736b4c	1	package DBIx::Class::StartupCheck;
11736b4c	2
b46b8537	3	use warnings;
b46b8537	4	use strict;
b46b8537	5
a2bd3796	6	1;
	7
	8	__END__
	9
11736b4c	10	=head1 NAME
	11
	12	DBIx::Class::StartupCheck - Run environment checks on startup
	13
	14	=head1 SYNOPSIS
	15
	16	use DBIx::Class::StartupCheck;
d4daee7b	17
11736b4c	18	=head1 DESCRIPTION
11736b4c	19
dc253b77	20	This module used to check for, and if necessary issue a warning for, a
	21	particular bug found on Red Hat and Fedora systems using their system
	22	perl build. As of September 2008 there are fixed versions of perl for
	23	all current Red Hat and Fedora distributions, but the old check still
	24	triggers, incorrectly flagging those versions of perl to be buggy. A
	25	more comprehensive check has been moved into the test suite in
	26	C<t/99rh_perl_perf_bug.t> and further information about the bug has been
48580715	27	put in L<DBIx::Class::Manual::Troubleshooting>.
dc253b77	28
dc253b77	29	Other checks may be added from time to time.
11736b4c	30
11736b4c	31	Any checks herein can be disabled by setting an appropriate environment
dc253b77	32	variable. If your system suffers from a particular bug, you will get a
	33	warning message on startup sent to STDERR, explaining what to do about
	34	it and how to suppress the message. If you don't see any messages, you
	35	have nothing to worry about.
11736b4c	36
a2bd3796	37	=head1 FURTHER QUESTIONS?
11736b4c	38
a2bd3796	39	Check the list of L<additional DBIC resources\|DBIx::Class/GETTING HELP/SUPPORT>.
11736b4c	40
a2bd3796	41	=head1 COPYRIGHT AND LICENSE
11736b4c	42
a2bd3796	43	This module is free software L<copyright\|DBIx::Class/COPYRIGHT AND LICENSE>
	44	by the L<DBIx::Class (DBIC) authors\|DBIx::Class/AUTHORS>. You can
	45	redistribute it and/or modify it under the same terms as the
	46	L<DBIx::Class library\|DBIx::Class/COPYRIGHT AND LICENSE>.