30bc51f5820fdb218bb5e565242372bb9534b374
[dbsrgits/DBIx-Class.git] / lib / DBIx / Class / StartupCheck.pm
1 package DBIx::Class::StartupCheck;
2
3 =head1 NAME
4
5 DBIx::Class::StartupCheck - Run environment checks on startup
6
7 =head1 SYNOPSIS
8
9   use DBIx::Class::StartupCheck;
10
11 =head1 DESCRIPTION
12
13 This module used to check for, and if necessary issue a warning for, a
14 particular bug found on Red Hat and Fedora systems using their system
15 perl build. As of September 2008 there are fixed versions of perl for
16 all current Red Hat and Fedora distributions, but the old check still
17 triggers, incorrectly flagging those versions of perl to be buggy. A
18 more comprehensive check has been moved into the test suite in
19 C<t/99rh_perl_perf_bug.t> and further information about the bug has been
20 put in L<DBIx::Class::Manual::Troubleshooting>
21
22 Other checks may be added from time to time.
23
24 Any checks herein can be disabled by setting an appropriate environment
25 variable. If your system suffers from a particular bug, you will get a
26 warning message on startup sent to STDERR, explaining what to do about
27 it and how to suppress the message. If you don't see any messages, you
28 have nothing to worry about.
29
30 =head1 CONTRIBUTORS
31
32 Nigel Metheringham
33
34 Brandon Black
35
36 Matt S. Trout
37
38 =head1 AUTHOR
39
40 Jon Schutz
41
42 =head1 LICENSE
43
44 You may distribute this code under the same terms as Perl itself.
45
46 =cut
47
48 1;