ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/Canary-Stability/Stability.pm
(Generate patch)

Comparing Canary-Stability/Stability.pm (file contents):
Revision 1.4 by root, Fri Jun 5 00:39:05 2015 UTC vs.
Revision 1.9 by root, Sat Sep 24 23:50:03 2016 UTC

16although in principle nothing prevents them from subscribing to the same 16although in principle nothing prevents them from subscribing to the same
17ideas. 17ideas.
18 18
19See the F<Makefile.PL> in L<Coro> or L<AnyEvent> for usage examples. 19See the F<Makefile.PL> in L<Coro> or L<AnyEvent> for usage examples.
20 20
21=over 4
22
23=cut 21=cut
24 22
25package Canary::Stability; 23package Canary::Stability;
26 24
27BEGIN { 25BEGIN {
28 $VERSION = 2001; 26 $VERSION = 2012;
29} 27}
30 28
31sub sgr { 29sub sgr {
32 # we just assume ANSI almost everywhere 30 # we just assume ANSI almost everywhere
33 # red 31, yellow 33, green 32 31 # red 31, yellow 33, green 32
32 local $| = 1;
34 33
35 $ENV{PERL_CANARY_STABILITY_COLOUR} ne 0 34 $ENV{PERL_CANARY_STABILITY_COLOUR} ne 0
36 and ((-t STDOUT and length $ENV{TERM}) or $ENV{PERL_CANARY_STABILITY_COLOUR}) 35 and ((-t STDOUT and length $ENV{TERM}) or $ENV{PERL_CANARY_STABILITY_COLOUR})
37 and print "\e[$_[0]m"; 36 and print "\e[$_[0]m";
38} 37}
43 $ENV{PERL_CANARY_STABILITY_DISABLE} 42 $ENV{PERL_CANARY_STABILITY_DISABLE}
44 and return; 43 and return;
45 44
46 $minperl ||= 5.008002; 45 $minperl ||= 5.008002;
47 46
47 print <<EOF;
48
49***
50*** Canary::Stability COMPATIBILITY AND SUPPORT CHECK
51*** =================================================
52***
53*** Hi!
54***
55*** I do my best to provide predictable and reliable software.
56***
57*** However, in recent releases, P5P (who maintain perl) have been
58*** introducing regressions that are sometimes subtle and at other times
59*** catastrophic, often for personal preferences with little or no concern
60*** for existing code, most notably CPAN.
61***
62*** For this reason, it has become very hard for me to maintain the level
63*** of reliability and support I have committed myself to in the past, at
64*** least with some perl versions: I simply can't keep up working around new
65*** bugs or gratituous incompatibilities, and in turn you might suffer from
66*** unanticipated problems.
67***
68*** Therefore I have introduced a support and compatibility check, the results
69*** of which follow below, together with a FAQ and some recommendations.
70***
71*** This check is just to let you know that there might be a risk, so you can
72*** make judgement calls on how to proceed - it will not keep the module from
73*** installing or working.
74***
75EOF
76
48 if ($minvers > $VERSION) { 77 if ($minvers > $VERSION) {
49 sgr 33; 78 sgr 33;
50 print <<EOF; 79 print <<EOF;
51
52***
53*** The stability canary says: (nothing, it died of old age). 80*** The stability canary says: (nothing, it died of old age).
54*** 81***
55*** Your Canary::Stability module (used by $distname) is too old. 82*** Your Canary::Stability module (used by $distname) is too old.
56*** This is not a fatal problem - while you might want to upgrade to version 83*** This is not a fatal problem - while you might want to upgrade to version
57*** $minvers (currently installed version: $VERSION) to get better support 84*** $minvers (currently installed version: $VERSION) to get better support
58*** status testing, you might also not want to care at all, and all will 85*** status testing, you might also not want to care at all, and all will
59*** be well as long $distname works well enough for you, as the stability 86*** be well as long $distname works well enough for you, as the stability
60*** canary is only used when installing the distribution. 87*** canary is only used when installing the distribution.
61***
62
63EOF 88EOF
64 } elsif ($] < $minperl) { 89 } elsif ($] < $minperl) {
65 90
66 sgr 33; 91 sgr 33;
67 print <<EOF; 92 print <<EOF;
68
69***
70*** The stability canary says: chirp (it seems concerned about something). 93*** The stability canary says: chirp (it seems concerned about something).
71*** 94***
72*** Your perl version ($]) is older than the $distname distribution 95*** Your perl version ($]) is older than the $distname distribution
73*** likes ($minperl). This is not a fatal problem - the module might work 96*** likes ($minperl). This is not a fatal problem - the module might work
74*** well with your version of perl, but it does mean the author likely 97*** well with your version of perl, but it does mean the author likely
75*** won't do anything to make it work if it breaks. 98*** won't do anything to make it work if it breaks.
76***
77
78EOF 99EOF
79 } elsif (defined $Internals::StabilityBranchVersion) { 100 } elsif (defined $Internals::StabilityBranchVersion) {
80 # note to people studying this modules sources: 101 # note to people studying this modules sources:
81 # the above test is not considered a clean or stable way to 102 # the above test is not considered a clean or stable way to
82 # test for the stability branch. 103 # test for the stability branch.
83 104
84 sgr 32; 105 sgr 32;
85 print <<EOF; 106 print <<EOF;
86
87***
88*** The stability canary says: chirp! chirp! (it seems to be quite excited) 107*** The stability canary says: chirp! chirp! (it seems to be quite excited)
89*** 108***
90*** It seems you are running schmorp's stability branch of perl. 109*** It seems you are running schmorp's stability branch of perl.
91*** All should be well, and if it isn't, you should report this as a bug 110*** All should be well, and if it isn't, you should report this as a bug
92*** to the $distname author. 111*** to the $distname author.
93***
94
95EOF 112EOF
96 } elsif ($] <= 5.020) { 113 } elsif ($] < 5.021) {
97 #sgr 32; 114 #sgr 32;
98 print <<EOF; 115 print <<EOF;
99
100***
101*** The stability canary says: chirp! chirp! (it seems to be quite happy) 116*** The stability canary says: chirp! chirp! (it seems to be quite happy)
102*** 117***
103*** Your version of perl ($]) is quite supported by $distname, nothing 118*** Your version of perl ($]) is quite supported by $distname, nothing
104*** else to be said, hope it comes in handy. 119*** else to be said, hope it comes in handy.
105***
106
107EOF 120EOF
108 } else { 121 } else {
109 sgr 31; 122 sgr 31;
110 print <<EOF; 123 print <<EOF;
111
112***
113*** The stability canary says: (nothing, it was driven away by harsh weather) 124*** The stability canary says: (nothing, it was driven away by harsh weather)
114*** 125***
115*** It seems you are running perl version $], likely the "official" or 126*** It seems you are running perl version $], likely the "official" or
116*** "standard" version. While there is nothing wrong with doing that, 127*** "standard" version. While there is nothing wrong with doing that,
117*** standard perl versions 5.022 and up are not supported by $distname. 128*** standard perl versions 5.022 and up are not supported by $distname.
118*** While this might be fatal, it might also be all right - if you run into 129*** While this might be fatal, it might also be all right - if you run into
119*** problems, you might want to downgrade your perl or switch to the 130*** problems, you might want to downgrade your perl or switch to the
120*** stability branch. 131*** stability branch.
121*** 132***
122*** If everything works fine, you can ignore this message. 133*** If everything works fine, you can ignore this message.
123***
124EOF 134EOF
125 sgr 0; 135 sgr 0;
126 print <<EOF; 136 print <<EOF;
137***
127*** Stability canary mini-FAQ: 138*** Stability canary mini-FAQ:
128*** 139***
129*** Do I need to do anything? 140*** Do I need to do anything?
130*** With luck, no. While some distributions are known to fail 141*** With luck, no. While some distributions are known to fail
131*** already, most should probably work. This message is here 142*** already, most should probably work. This message is here
144*** 155***
145*** How can I skip this prompt on automated installs? 156*** How can I skip this prompt on automated installs?
146*** Set PERL_CANARY_STABILITY_NOPROMPT=1 in your environment. 157*** Set PERL_CANARY_STABILITY_NOPROMPT=1 in your environment.
147*** More info is in the Canary::Stability manpage. 158*** More info is in the Canary::Stability manpage.
148*** 159***
149*** Long version of this FAQ: http://stabilityperl.schmorp.de/faq.html 160*** Long version of this FAQ: http://stableperl.schmorp.de/faq.html
150*** Stability Branch homepage: http://stabilityperl.schmorp.de/ 161*** Stability Branch homepage: http://stableperl.schmorp.de/
151*** 162***
152 163
153EOF 164EOF
154 165
155 unless ($ENV{PERL_CANARY_STABILITY_NOPROMPT}) { 166 unless ($ENV{PERL_CANARY_STABILITY_NOPROMPT}) {
186=back 197=back
187 198
188=head1 AUTHOR 199=head1 AUTHOR
189 200
190 Marc Lehmann <schmorp@schmorp.de> 201 Marc Lehmann <schmorp@schmorp.de>
191 http://home.schmorp.de/ 202 http://software.schmorp.de/pkg/Canary-Stability.html
192 203
193=cut 204=cut
194 205
1951 2061
196 207

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines