This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Porting/bump-perl-version: No need to try other maps after one has worked
[perl5.git] / Porting / bump-perl-version
CommitLineData
ae1b7029
DM
1#!/usr/bin/perl
2#
3# bump-perl-version, DAPM 14 Jul 2009
4#
5# A utility to find, and optionally bump, references to the perl version
6# number in various files within the perl source
7#
8# It's designed to work in two phases. First, when run with -s (scan),
9# it searches all the files in MANIFEST looking for strings that appear to
10# match the current perl version (or which it knows are *supposed* to
11# contain the current version), and produces a list of them to stdout,
12# along with a suggested edit. For example:
13#
14# $ Porting/bump-perl-version -s 5.10.0 5.10.1 > /tmp/scan
15# $ cat /tmp/scan
16# Porting/config.sh
17#
18# 52: -archlib='/opt/perl/lib/5.10.0/i686-linux-64int'
19# +archlib='/opt/perl/lib/5.10.1/i686-linux-64int'
20# ....
21#
22# At this point there will be false positives. Edit the file to remove
23# those changes you don't want made. Then in the second phase, feed that
24# list in, and it will change those lines in the files:
25#
26# $ Porting/bump-perl-version -u < /tmp/scan
27#
28# (so line 52 of Porting/config.sh is now updated)
5302eb95
JL
29#
30# The -i option can be used to combine these two steps (if you prefer to make
31# all of the changes at once and then edit the results via git).
ae1b7029
DM
32
33# This utility 'knows' about certain files and formats, and so can spot
34# 'hidden' version numbers, like PERL_SUBVERSION=9.
35#
36# A third variant makes use of this knowledge to check that all the things
37# it knows about are at the current version:
38#
39# $ Porting/bump-perl-version -c 5.10.0
40#
41# XXX this script hasn't been tested against a major version bump yet,
42# eg 5.11.0 to 5.12.0; there may be things it missed - DAPM 14 Jul 09
43#
44# Note there are various files and directories that it skips; these are
45# ones that are unlikely to contain anything needing bumping, but which
730ad6b9 46# will generate lots of false positives (eg pod/*). These are listed on
ae1b7029
DM
47# STDERR as they are skipped.
48
49use strict;
50use warnings;
204fc54e 51use autodie;
ae1b7029
DM
52use Getopt::Std;
53use ExtUtils::Manifest;
54
55
56sub usage { die <<EOF }
57
58@_
59
60usage: $0 -c <C.C.C>
61 -s <C.C.C> <N.N.N>
62 -u
dc40e497 63 -i <C.C.C> <N.N.N>
ae1b7029
DM
64
65 -c check files and warn if any known string values (eg
66 PERL_SUBVERSION) don't match the specified version
67
68 -s scan files and produce list of possible change lines to stdout
69
70 -u read in the scan file from stdin, and change all the lines specified
71
dc40e497
LB
72 -i scan files and make changes inplace
73
ae1b7029
DM
74 C.C.C the current perl version, eg 5.10.0
75 N.N.N the new perl version, eg 5.10.1
76EOF
77
78my %opts;
dc40e497 79getopts('csui', \%opts) or usage;
ae1b7029 80if ($opts{u}) {
47e01c32 81 @ARGV == 0 or usage('no version version numbers should be specified');
ae1b7029
DM
82 # fake to stop warnings when calculating $oldx etc
83 @ARGV = qw(99.99.99 99.99.99);
84}
85elsif ($opts{c}) {
86 @ARGV == 1 or usage('required one version number');
87 push @ARGV, $ARGV[0];
88}
89else {
90 @ARGV == 2 or usage('require two version numbers');
91}
dc40e497 92usage('only one of -c, -s, -u and -i') if keys %opts > 1;
ae1b7029
DM
93
94my ($oldx, $oldy, $oldz) = $ARGV[0] =~ /^(\d+)\.(\d+)\.(\d+)$/
95 or usage("bad version: $ARGV[0]");
96my ($newx, $newy, $newz) = $ARGV[1] =~ /^(\d+)\.(\d+)\.(\d+)$/
97 or usage("bad version: $ARGV[1]");
98
99my $old_decimal = sprintf "%d.%03d%03d", $oldx, $oldy, $oldz; # 5.011001
100
101# each entry is
102# 0 a regexp that matches strings that might contain versions;
103# 1 a sub that returns two strings based on $1 etc values:
104# * string containing captured values (for -c)
105# * a string containing the replacement value
106# 2 what we expect the sub to return as its first arg; undef implies
107# don't match
108# 3 a regex restricting which files this applies to (undef is all files)
109#
110# Note that @maps entries are checks in order, and only the first to match
111# is used.
112
113my @maps = (
114 [
115 qr{^((?:api_)?version(?:=|\s+)'?) (\d+) ('?) (?!\.)}x,
116 sub { $2, "$1$newy$3" },
117 $oldy,
118 qr/config/,
119 ],
120 [
121 qr{^(subversion(?:=|\s+)'?) (\d+) ('?) (?!\.)}x,
122 sub { $2, "$1$newz$3" },
123 $oldz,
124 qr/config/,
125 ],
126 [
127 qr{^(api_subversion(?:=|\s+)'?) (\d+) ('?) (?!\.)}x,
544af516
FR
128 sub { $2, ($newy % 2) ? "$1$newz$3" : "${1}0$3" },
129 ($oldy % 2) ? $oldz : 0,
ae1b7029
DM
130 qr/config/,
131 ],
132 [
133 qr{^(api_versionstring(?:=|\s+)'?) ([\d\.]+) ('?) (?!\.)}x,
544af516
FR
134 sub { $2, ($newy % 2) ? "$1$newx.$newy.$newz$3": "$1$newx.$newy.0$3" },
135 ($oldy % 2) ? "$oldx.$oldy.$oldz" : "$oldx.$oldy.0",
ae1b7029
DM
136 qr/config/,
137 ],
138 [
139 qr{(version\s+'?) (\d+) ('?\s+subversion\s+'?) (\d+) ('?) (?!\.)}x,
140 sub { "$2-$4", "$1$newy$3$newz$5" },
141 "$oldy-$oldz",
142 qr/config/,
143 ],
144 [
145 qr{\b (PERL_(?:API_)?VERSION(?:=|\s+)'?) (\d+) ('?) (?!\.)}x,
146 sub { $2, "$1$newy$3"},
147 $oldy,
148 ],
149 [
150 qr{\b (PERL_SUBVERSION(?:=|\s+)'?) (\d+) ('?) (?!\.)}x,
151 sub { $2, "$1$newz$3"},
544af516 152 ($oldy % 2) ? $oldz : 0,
ae1b7029
DM
153 ],
154 [
155 qr{\b (PERL_API_SUBVERSION(?:=|\s+)'?) (\d+) ('?) (?!\.)}x,
544af516
FR
156 sub { $2, ($newy % 2) ? "$1$newz$3" : "${1}0$3" },
157 $oldz,
ae1b7029
DM
158 ],
159 # these two formats are in README.vms
160 [
161 qr{\b perl-(\d+\^\.\d+\^\.\d+) \b}x,
162 sub { $1, "perl-$newx^.$newy^.$newz"},
163 undef,
164 ],
165 [
166 qr{\b ($oldx _ $oldy _$oldz) \b}x,
167 sub { $1, ($newx . '_' . $newy . '_' . $newz)},
168 undef,
169 ],
170 # 5.8.9
171 [
8b8cdb3a 172 qr{ $oldx\.$oldy\.$oldz \b}x,
ae1b7029
DM
173 sub {"", "$newx.$newy.$newz"},
174 undef,
175 ],
176
177 # 5.008009
178 [
8b8cdb3a 179 qr{ $old_decimal \b}x,
ae1b7029
DM
180 sub {"", sprintf "%d.%03d%03d", $newx, $newy, $newz },
181 undef,
182 ],
183
d4f05c0b 184 # perl511, perl511.dll, perl511.lib, perl511s.lib, libperl511.a
7dfca73b 185 [
d4f05c0b
VP
186 qr{\b ((?:lib)?) perl (\d\d\d) (s?) \b }x,
187 sub {$2, "$1perl$newx$newy$3" },
7dfca73b 188 "$oldx$oldy",
d9f179d8 189 qr/win32|hints/, # README.win32, win32/*, hints/*
7dfca73b
JD
190 ],
191
2e55877c
DL
192 # microperl locations should be bumped for major versions
193 [
194 qr{(/)(\d\.\d{2})(["'/])},
195 sub { $2, "$1$newx.$newy$3" },
196 "$oldx.$oldy",
197 qr/uconfig/,
198 ],
199
a24e4318
TC
200 # win32/Makefile.ce
201 [
202 qr/(PV\s*=\s*)(\d\d{2})\b$/,
203 sub { $2, "$1$newx$newy" },
204 "$oldx$oldy",
205 qr/Makefile\.ce/,
206 ],
ae1b7029
DM
207);
208
209
210# files and dirs that we likely don't want to change version numbers on.
211
212my %SKIP_FILES = map { ($_ => 1) } qw(
213 Changes
214 MANIFEST
dac70e9b
Z
215 Porting/Maintainers.pl
216 Porting/acknowledgements.pl
aa1602b3 217 Porting/corelist-perldelta.pl
87f4ab41 218 Porting/epigraphs.pod
ae1b7029 219 Porting/how_to_write_a_perldelta.pod
5bd03515 220 Porting/release_managers_guide.pod
87f4ab41 221 Porting/release_schedule.pod
8b8cdb3a 222 Porting/bump-perl-version
5bd03515 223 pp_ctl.c
ae1b7029
DM
224);
225my @SKIP_DIRS = qw(
e6dc1cfe 226 dist
ae1b7029
DM
227 ext
228 lib
229 pod
d634733c 230 cpan
ae1b7029
DM
231 t
232);
233
234my @mani_files = sort keys %{ExtUtils::Manifest::maniread('MANIFEST')};
235my %mani_files = map { ($_ => 1) } @mani_files;
236die "No entries found in MANIFEST; aborting\n" unless @mani_files;
237
dc40e497 238if ($opts{c} or $opts{s} or $opts{i}) {
ae1b7029
DM
239 do_scan();
240}
241elsif ($opts{u}) {
242 do_update();
243}
244else {
47e01c32 245 usage('one of -c, -s or -u must be specified');
ae1b7029
DM
246}
247exit 0;
248
249
250
251
252sub do_scan {
253 for my $file (@mani_files) {
e6dc1cfe 254 next if grep $file =~ m{^$_/}, @SKIP_DIRS;
ae1b7029
DM
255 if ($SKIP_FILES{$file}) {
256 warn "(skipping $file)\n";
257 next;
258 }
204fc54e 259 open my $fh, '<', $file;
ae1b7029 260 my $header = 0;
dc40e497
LB
261 my @stat = stat $file;
262 my $mode = $stat[2];
263 my $file_changed = 0;
264 my $new_contents = '';
ae1b7029 265
582c9380
LB
266 while (my $line = <$fh>) {
267 my $oldline = $line;
cc56b22c 268 my $line_changed = 0;
ae1b7029
DM
269 for my $map (@maps) {
270 my ($pat, $sub, $expected, $file_pat) = @$map;
271
272 next if defined $file_pat and $file !~ $file_pat;
582c9380 273 next unless $line =~ $pat;
ae1b7029
DM
274 my ($got, $replacement) = $sub->();
275
276 if ($opts{c}) {
277 # only report unexpected
278 next unless defined $expected and $got ne $expected;
279 }
582c9380 280 $line =~ s/$pat/$replacement/
ae1b7029 281 or die "Internal error: substitution failed: [$pat]\n";
cc56b22c
SH
282 if ($line ne $oldline) {
283 $line_changed = 1;
284 last;
285 }
582c9380
LB
286 }
287 $new_contents .= $line if $opts{i};
cc56b22c 288 if ($line_changed) {
582c9380
LB
289 $file_changed = 1;
290 if ($opts{s}) {
291 print "\n$file\n" unless $header;
292 $header=1;
293 printf "\n%5d: -%s +%s", $., $oldline, $line;
ae1b7029 294 }
ae1b7029 295 }
dc40e497
LB
296 }
297 if ($opts{i} && $file_changed) {
298 warn "Updating $file inplace\n";
299 open my $fh, '>', $file;
300 binmode $fh;
301 print $fh $new_contents;
302 close $fh;
303 chmod $mode & 0777, $file;
ae1b7029
DM
304 }
305 }
306 warn "(skipped $_/*)\n" for @SKIP_DIRS;
307}
308
309sub do_update {
310
311 my %changes;
312 my $file;
313 my $line;
314
315 # read in config
316
317 while (<STDIN>) {
318 next unless /\S/;
319 if (/^(\S+)$/) {
320 $file = $1;
321 die "No such file in MANIFEST: '$file'\n" unless $mani_files{$file};
322 die "file already seen; '$file'\n" if exists $changes{$file};
323 undef $line;
324 }
325 elsif (/^\s+(\d+): -(.*)/) {
326 my $old;
327 ($line, $old) = ($1,$2);
47e01c32 328 die "$.: old line without preceding filename\n"
ae1b7029
DM
329 unless defined $file;
330 die "Dup line number: $line\n" if exists $changes{$file}{$line};
331 $changes{$file}{$line}[0] = $old;
332 }
333 elsif (/^\s+\+(.*)/) {
334 my $new = $1;
335 die "$.: replacement line seen without old line\n" unless $line;
336 $changes{$file}{$line}[1] = $new;
337 undef $line;
338 }
339 else {
340 die "Unexpected line at ;line $.: $_\n";
341 }
342 }
343
344 # suck in file contents to memory, then update that in-memory copy
345
346 my %contents;
347 for my $file (sort keys %changes) {
204fc54e 348 open my $fh, '<', $file;
33c1015f 349 binmode $fh;
ae1b7029
DM
350 $contents{$file} = [ <$fh> ];
351 chomp @{$contents{$file}};
204fc54e 352 close $fh;
ae1b7029
DM
353
354 my $entries = $changes{$file};
355 for my $line (keys %$entries) {
356 die "$file: no such line: $line\n"
357 unless defined $contents{$file}[$line-1];
358 if ($contents{$file}[$line-1] ne $entries->{$line}[0]) {
359 die "$file: line mismatch at line $line:\n"
360 . "File: [$contents{$file}[$line-1]]\n"
361 . "Config: [$entries->{$line}[0]]\n"
362 }
363 $contents{$file}[$line-1] = $entries->{$line}[1];
364 }
365 }
366
367 # check the temp files don't already exist
368
369 for my $file (sort keys %contents) {
370 my $nfile = "$file-new";
371 die "$nfile already exists in MANIFEST; aborting\n"
372 if $mani_files{$nfile};
373 }
374
375 # write out the new files
376
377 for my $file (sort keys %contents) {
378 my $nfile = "$file-new";
204fc54e 379 open my $fh, '>', $nfile;
33c1015f 380 binmode $fh;
ae1b7029 381 print $fh $_, "\n" for @{$contents{$file}};
204fc54e 382 close $fh;
ae1b7029 383
204fc54e 384 my @stat = stat $file;
ae1b7029
DM
385 my $mode = $stat[2];
386 die "stat $file fgailed to give a mode!\n" unless defined $mode;
204fc54e 387 chmod $mode & 0777, $nfile;
ae1b7029
DM
388 }
389
390 # and rename them
391
392 for my $file (sort keys %contents) {
393 my $nfile = "$file-new";
394 warn "updating $file ...\n";
204fc54e 395 rename $nfile, $file;
ae1b7029
DM
396 }
397}
398