This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Fix POD issues
[perl5.git] / Porting / release_managers_guide.pod
CommitLineData
49781f4a
AB
1=encoding utf8
2
7277a900
GS
3=head1 NAME
4
5release_managers_guide - Releasing a new version of perl 5.x
6
dc0a4df9
DM
7Note that things change at each release, so there may be new things not
8covered here, or tools may need updating.
9
c78277ad
DR
10=head1 MAKING A CHECKLIST
11
12If you are preparing to do a release, you can run the
13F<Porting/make-rmg-checklist> script to generate a new version of this
14document that starts with a checklist for your release.
15
16This script is run as:
17
18 perl Porting/make-rmg-checklist \
19 --type [BLEAD-POINT or MAINT or ...] > /tmp/rmg.pod
20
21You can also pass the C<--html> flag to generate an HTML document instead of
22POD.
f6af4394 23
0056d3d2
DR
24 perl Porting/make-rmg-checklist --html \
25 --type [BLEAD-POINT or MAINT or ...] > /tmp/rmg.html
26
7277a900
GS
27=head1 SYNOPSIS
28
f6af4394 29This document describes the series of tasks required - some automatic, some
dc0a4df9
DM
30manual - to produce a perl release of some description, be that a release
31candidate, or final, numbered release of maint or blead.
f6af4394 32
8c35d285 33The release process has traditionally been executed by the current
ee76d676
JV
34pumpking. Blead releases from 5.11.0 forward are made each month on the
3520th by a non-pumpking release engineer. The release engineer roster
36and schedule can be found in Porting/release_schedule.pod.
7277a900 37
8c35d285
JV
38This document both helps as a check-list for the release engineer
39and is a base for ideas on how the various tasks could be automated
40or distributed.
7277a900 41
da571fa1 42The checklist of a typical release cycle is as follows:
f6af4394 43
636a1918 44 (5.10.1 is released, and post-release actions have been done)
f6af4394
DM
45
46 ...time passes...
47
f6af4394
DM
48 a few weeks before the release, a number of steps are performed,
49 including bumping the version to 5.10.2
636a1918
DM
50
51 ...a few weeks passes...
46743ef7 52
f6af4394
DM
53 perl-5.10.2-RC1 is released
54
55 perl-5.10.2 is released
56
57 post-release actions are performed, including creating new
c5b87fed 58 perldelta.pod
f6af4394
DM
59
60 ... the cycle continues ...
7277a900 61
dc0a4df9 62
7277a900
GS
63=head1 DETAILS
64
6a958a95
DM
65Some of the tasks described below apply to all four types of
66release of Perl. (blead, RC, final release of maint, final
8c35d285
JV
67release of blead). Some of these tasks apply only to a subset
68of these release types. If a step does not apply to a given
69type of release, you will see a notation to that effect at
70the beginning of the step.
71
dc0a4df9 72
8c35d285
JV
73=head2 Release types
74
75=over 4
76
8c35d285
JV
77=item Release Candidate (RC)
78
d60a1044
DM
79A release candidate is an attempt to produce a tarball that is a close as
80possible to the final release. Indeed, unless critical faults are found
81during the RC testing, the final release will be identical to the RC
82barring a few minor fixups (updating the release date in F<perlhist.pod>,
83removing the RC status from F<patchlevel.h>, etc). If faults are found,
84then the fixes should be put into a new release candidate, never directly
85into a final release.
8c35d285 86
6a958a95
DM
87
88=item Stable/Maint release (MAINT).
89
90A release with an even version number, and subversion number > 0, such as
915.14.1 or 5.14.2.
8c35d285
JV
92
93At this point you should have a working release candidate with few or no
94changes since.
95
96It's essentially the same procedure as for making a release candidate, but
97with a whole bunch of extra post-release steps.
98
6a958a95
DM
99=item A blead point release (BLEAD-POINT)
100
101A release with an odd version number, such as 5.15.0 or 5.15.1.
102
103This isn't for production, so it has less stability requirements than for
104other release types, and isn't preceded by RC releases. Other than that,
105it is similar to a MAINT release.
106
107=item Blead final release (BLEAD-FINAL)
108
109A release with an even version number, and subversion number == 0, such as
dc0a4df9 1105.14.0. That is to say, it's the big new release once per year.
8c35d285
JV
111
112It's essentially the same procedure as for making a release candidate, but
6a958a95 113with a whole bunch of extra post-release steps, even more than for MAINT.
8c35d285
JV
114
115=back
7277a900 116
da571fa1 117=for checklist begin
dc0a4df9 118
fd838dcf
JV
119=head2 Prerequisites
120
121Before you can make an official release of perl, there are a few
122hoops you need to jump through:
123
00c28750 124=head3 PAUSE account with pumpkin status
8c35d285 125
fd838dcf
JV
126Make sure you have a PAUSE account suitable for uploading a perl release.
127If you don't have a PAUSE account, then request one:
128
129 https://pause.perl.org/pause/query?ACTION=request_id
130
9a3b7d40
FR
131Check that your account is allowed to upload perl distros: go to
132L<https://pause.perl.org/pause/authenquery?ACTION=who_pumpkin> and check that
133your PAUSE ID is listed there. If not, ask Andreas KE<0xf6>nig to add your ID
134to the list of people allowed to upload something called perl. You can find
135Andreas' email address at:
4d2c8158 136
fd838dcf
JV
137 https://pause.perl.org/pause/query?ACTION=pause_04imprint
138
00c28750 139=head3 search.cpan.org pumpkin status
fdabea7a
JV
140
141Make sure that search.cpan.org knows that you're allowed to upload
142perl distros. Contact Graham Barr to make sure that you're on the right
143list.
144
a72d816c
RS
145=head3 rt.perl.org update access
146
147Make sure you have permission to close tickets on L<http://rt.perl.org/>
148so you can respond to bug report as necessary during your stint. If you
149don't, make an account (if you don't have one) and contact the pumpking
150with your username to get ticket-closing permission.
151
da571fa1 152=head3 git checkout and commit bit
fd838dcf
JV
153
154You will need a working C<git> installation, checkout of the perl
155git repository and perl commit bit. For information about working
c222ef46 156with perl and git, see F<pod/perlgit.pod>.
fd838dcf
JV
157
158If you are not yet a perl committer, you won't be able to make a
159release. Have a chat with whichever evil perl porter tried to talk
160you into the idea in the first place to figure out the best way to
161resolve the issue.
162
845a9291
MM
163=head3 git clone of https://github.com/perlorg/perlweb
164
165For updating the L<http://dev.perl.org> web pages, either a Github account or
166sweet-talking somebody with a Github account into obedience is needed. This
167is only needed on the day of the release or shortly afterwards.
168
da571fa1 169=for checklist skip RC
f6af4394 170
da571fa1 171=head3 Quotation for release announcement epigraph
f6af4394 172
b1288acc 173I<SKIP this step for RC>
f6af4394 174
6a958a95 175For all except an RC release of perl, you will need a quotation
b1288acc 176to use as an epigraph to your release announcement.
46743ef7 177
2e831dfd 178=head2 Building a release - advance actions
8c35d285 179
9c39c536
A
180The work of building a release candidate for an even numbered release
181(BLEAD-FINAL) of perl generally starts several weeks before the first
182release candidate. Some of the following steps should be done regularly,
183but all I<must> be done in the run up to a release.
7277a900 184
dc0a4df9 185=head3 dual-life CPAN module synchronisation
f6af4394 186
f6af4394
DM
187Ensure that dual-life CPAN modules are synchronised with CPAN. Basically,
188run the following:
189
db3f805e 190 $ ./perl -Ilib Porting/core-cpan-diff -a -o /tmp/corediffs
7277a900 191
f6af4394
DM
192to see any inconsistencies between the core and CPAN versions of distros,
193then fix the core, or cajole CPAN authors as appropriate. See also the
194C<-d> and C<-v> options for more detail. You'll probably want to use the
04dbb930
DG
195C<-c cachedir> option to avoid repeated CPAN downloads and may want to
196use C<-m file:///mirror/path> if you made a local CPAN mirror.
7277a900 197
f6af4394 198To see which core distro versions differ from the current CPAN versions:
7277a900 199
db3f805e 200 $ ./perl -Ilib Porting/core-cpan-diff -x -a
7277a900 201
6a958a95 202If you are making a MAINT release, run C<core-cpan-diff> on both blead and
636a1918
DM
203maint, then diff the two outputs. Compare this with what you expect, and if
204necessary, fix things up. For example, you might think that both blead
205and maint are synchronised with a particular CPAN module, but one might
206have some extra changes.
207
9c39c536
A
208=head3 How to sync a CPAN module with a cpan/ distro
209
210=over 4
211
212=item *
213
214Fetch the most recent version from CPAN.
215
216=item *
217
218Unpack the retrieved tarball. Rename the old directory; rename the new
219directory to the original name.
220
221=item *
222
02cbdfef
A
223Restore any F<.gitignore> file. This can be done by issueing
224C<git checkout .gitignore> in the F<cpan/Distro> directory.
9c39c536
A
225
226=item *
227
228Remove files we do not need. That is, remove any files that match the
02cbdfef 229entries in C<@IGNORE> in F<Porting/Maintainer.pl>, and anything that
9c39c536
A
230matches the C<EXCLUDED> section of the distro's entry in the C<%Modules>
231hash.
232
233=item *
234
235Restore any files mentioned in the C<CUSTOMIZED> section, using
236C<git checkout>. Make any new customizations if necessary. Also,
237restore any files that are mentioned in C<@IGNORE>, but were checked
238in in the repository anyway.
239
240=item *
241
242For any new files in the distro, determine whether they are needed.
243If not, delete them, and list them in either C<EXCLUDED> or C<@INGORE>.
244Otherwise, add them to C<MANIFEST>, and run C<git add> to add the files
245to the repository.
246
247=item *
248
249For any files that are gone, remove them from C<MANIFEST>, and use
250C<git rm> to tell git the files will be gone.
251
252=item *
253
254If the C<MANIFEST> file was changed in any of the previous steps, run
255C<perl Porting/manisort --output MANIFEST.sort; mv MANIFEST.sort MANIFEST>.
256
257=item *
258
259For any files that have an execute bit set, either remove the execute
02cbdfef 260bit, or edit F<Porting/exec-bit.txt>
9c39c536
A
261
262=item *
263
264Run C<make>, see if C<perl> compiles.
265
266=item *
267
268Run the tests for the package.
269
270=item *
271
02cbdfef 272Run the tests in F<t/porting>.
9c39c536
A
273
274=item *
275
02cbdfef 276Update the C<DISTRIBUTION> entry in F<Porting/Maintainers.pl>.
9c39c536
A
277
278=item *
279
280Run a full configure/build/test cycle.
281
282=item *
283
284If everything is ok, commit the changes.
285
286=back
287
288For entries with a non-simple C<FILES> section, or with a C<MAP>, you
289may have to take more steps than listed above.
290
02cbdfef 291F<Porting/sync-with-cpan> is a script that automates most of the steps
9c39c536
A
292above; but see the comments at the beginning of the file.
293
dc0a4df9
DM
294
295=head3 dual-life CPAN module stability
7277a900 296
f6af4394 297Ensure dual-life CPAN modules are stable, which comes down to:
7277a900
GS
298
299 for each module that fails its regression tests on $current
f6af4394
DM
300 did it fail identically on $previous?
301 if yes, "SEP" (Somebody Else's Problem)
302 else work out why it failed (a bisect is useful for this)
7277a900
GS
303
304 attempt to group failure causes
305
306 for each failure cause
f6af4394
DM
307 is that a regression?
308 if yes, figure out how to fix it
309 (more code? revert the code that broke it)
310 else
311 (presumably) it's relying on something un-or-under-documented
312 should the existing behaviour stay?
313 yes - goto "regression"
314 no - note it in perldelta as a significant bugfix
315 (also, try to inform the module's author)
1aff5354 316
dc0a4df9 317
00c28750 318=head3 monitor smoke tests for failures
7277a900 319
5157df7a
AB
320Similarly, monitor the smoking of core tests, and try to fix. See
321L<http://doc.procura.nl/smoke/index.html> for a summary. See also
322L<http://www.nntp.perl.org/group/perl.daily-build.reports/> which has
323the raw reports.
7277a900 324
636a1918
DM
325Similarly, monitor the smoking of perl for compiler warnings, and try to
326fix.
327
dc0a4df9 328
00c28750 329=head3 update perldelta
636a1918 330
f6af4394 331Get perldelta in a mostly finished state.
db3f805e 332
04c2c53e 333Read F<Porting/how_to_write_a_perldelta.pod>, and try to make sure that
636a1918
DM
334every section it lists is, if necessary, populated and complete. Copy
335edit the whole document.
f6af4394 336
f6af4394 337
dc0a4df9
DM
338=head3 Bump the version number
339
340Increase the version number (e.g. from 5.12.0 to 5.12.1).
04dbb930 341
6a958a95 342For a BLEAD-POINT release, this can happen on the day of the release. For a
04dbb930
DG
343release candidate for a stable perl, this should happen a week or two
344before the first release candidate to allow sufficient time for testing and
345smoking with the target version built into the perl executable. For
346subsequent release candidates and the final release, it it not necessary to
347bump the version further.
f6af4394 348
8b2227e6 349There is a tool to semi-automate this process:
f6af4394 350
8b2227e6 351 $ ./perl -Ilib Porting/bump-perl-version -i 5.10.0 5.10.1
f6af4394 352
8b2227e6
LB
353Remember that this tool is largely just grepping for '5.10.0' or whatever,
354so it will generate false positives. Be careful not change text like
355"this was fixed in 5.10.0"!
ceb7f800 356
8b2227e6 357Use git status and git diff to select changes you want to keep.
ceb7f800 358
f6af4394
DM
359Be particularly careful with F<INSTALL>, which contains a mixture of
360C<5.10.0>-type strings, some of which need bumping on every release, and
e03f126c
Z
361some of which need to be left unchanged.
362The line in F<INSTALL> about "is binary incompatible with" requires a
363correct choice of earlier version to declare incompatibility with.
364
6a958a95
DM
365When doing a BLEAD-POINT or BLEAD-FINAL release, also make sure the
366C<PERL_API_*> constants in F<patchlevel.h> are in sync with the version
367you're releasing, unless you're
e43cb88f 368absolutely sure the release you're about to make is 100% binary compatible
6a958a95 369to an earlier release. When releasing a MAINT perl version, the C<PERL_API_*>
e43cb88f
TM
370constants C<MUST NOT> be changed as we aim to guarantee binary compatibility
371in maint branches.
45ce9531 372
17163f85
DM
373After editing, regenerate uconfig.h (this must be run on a system with a
374/bin/sh available):
22be9667 375
17163f85 376 $ perl regen/uconfig_h.pl
22be9667
JV
377
378Test your changes:
379
17163f85 380 $ git clean -xdf # careful if you don't have local files to keep!
22be9667
JV
381 $ ./Configure -des -Dusedevel
382 $ make
383 $ make test
384
54356a6f
JV
385Commit your changes:
386
04abd20e 387 $ git status
e91bd5c0
LB
388 $ git diff
389 B<review the delta carefully>
54356a6f
JV
390
391 $ git commit -a -m 'Bump the perl version in various places for 5.x.y'
dc0a62a1 392
21768cb3
FC
393At this point you may want to compare the commit with a previous bump to
394see if they look similar. See commit 8891dd8d for an example of a
395previous version bump.
396
dc0a4df9
DM
397When the version number is bumped, you should also update Module::CoreList
398(as described below in L<"update Module::CoreList">) to reflect the new
81fc59ef
DG
399version number.
400
dc0a4df9
DM
401
402=head3 update INSTALL
dc0a62a1
DM
403
404Review and update INSTALL to account for the change in version number;
405in particular, the "Coexistence with earlier versions of perl 5" section.
406
6a958a95
DM
407Be particularly careful with the section "Upgrading from 5.X.Y or earlier".
408The "X.Y" needs to be changed to the most recent version that we are
409I<not> binary compatible with.
410
411For MAINT and BLEAD-FINAL releases, this needs to refer to the last
412release in the previous development cycle (so for example, for a 5.14.x
413release, this would be 5.13.11).
414
415For BLEAD-POINT releases, it needs to refer to the previous BLEAD-POINT
416release (so for 5.15.3 this would be 5.15.2).
417
dc0a4df9 418=head3 Check more build configurations
b82efa27 419
a65c7ffd 420Check some more build configurations.
52a66c2c
DM
421
422 $ sh Configure -Dprefix=/tmp/perl-5.x.y -Uinstallusrbinperl \
a65c7ffd 423 -Duseshrplib -Dusesitecustomize
52a66c2c 424 $ make
a65c7ffd 425 $ make test
7277a900 426
52a66c2c 427XXX think of other configurations that need testing.
7277a900 428
dc0a4df9
DM
429
430=head3 update perlport
7277a900 431
347f5124
RGS
432L<perlport> has a section currently named I<Supported Platforms> that
433indicates which platforms are known to build in the current release.
434If necessary update the list and the indicated version number.
435
6a958a95
DM
436
437
2e831dfd
DM
438=head2 Building a release - on the day
439
b1288acc
DM
440This section describes the actions required to make a release
441that are performed on the actual day.
2e831dfd 442
2e831dfd 443
dc0a4df9 444=head3 re-check earlier actions
2e831dfd 445
dc0a4df9 446Review all the actions in the previous section,
2e831dfd
DM
447L<"Building a release - advance actions"> to ensure they are all done and
448up-to-date.
449
dc0a4df9
DM
450
451=head3 bump version number
8c35d285 452
6a958a95
DM
453For a BLEAD-POINT release, if you did not bump the perl version number as
454part of I<advance actions>, do that now.
04dbb930 455
dc0a4df9
DM
456
457=head3 finalize perldelta
04dbb930 458
04dbb930 459Finalize the perldelta. In particular, fill in the Acknowledgements
548e9a3a 460section, which can be generated with something like:
38195a8c 461
548e9a3a 462 $ perl Porting/acknowledgements.pl v5.15.0..HEAD
ef86391b 463
a0db33fe
DM
464Re-read the perldelta to try to find any embarrassing typos and thinkos;
465remove any C<TODO> or C<XXX> flags; update the "Known Problems" section
466with any serious issues for which fixes are not going to happen now; and
467run through pod and spell checkers, e.g.
2e831dfd 468
c5b87fed
FR
469 $ podchecker -warnings -warnings pod/perldelta.pod
470 $ spell pod/perldelta.pod
2e831dfd 471
a0db33fe
DM
472Also, you may want to generate and view an HTML version of it to check
473formatting, e.g.
2e831dfd 474
3f894c2d 475 $ ./perl -Ilib ext/Pod-Html/bin/pod2html pod/perldelta.pod > /tmp/perldelta.html
2e831dfd 476
38195a8c
DG
477Another good HTML preview option is http://search.cpan.org/pod2html
478
479If you make changes, be sure to commit them.
480
da571fa1
DR
481=for checklist skip BLEAD-POINT MAINT RC
482
a03432f2
KW
483=head3 remove stale perldeltas
484
485For the first RC release that is ONLY for a BLEAD-FINAL, the perldeltas
486from the BLEAD-POINT releases since the previous BLEAD_FINAL should have
487now been consolidated into the current perldelta, and hence are now just
488useless clutter. They can be removed using:
489
490 $ git rm <file1> <file2> ...
491
492For example, for RC0 of 5.16.0:
493
494 $ cd pod
495 $ git rm perldelta515*.pod
496
ace68858
NC
497All mention to them should also be removed. Edit F<pod/perl.pod> to remove
498them from its table of contents, then run F<Porting/pod_rules.pl> to
499propagate your changes there into all the other files that mention them
500(including F<MANIFEST>). You'll need to C<git add> the files that it changes.
a03432f2
KW
501
502Then build a clean perl and do a full test
503
504 $ git status
505 $ git clean -dxf
506 $ ./Configure -Dusedevel -des
507 $ make
508 $ make test
509
510Once all tests pass, commit your changes.
dc0a4df9
DM
511
512=head3 build a clean perl
8c35d285 513
a03432f2
KW
514If you skipped the previous step (removing the stale perldeltas)
515make sure you have a gitwise-clean perl directory (no modified files,
a0db33fe 516unpushed commits etc):
8c35d285 517
a0db33fe 518 $ git status
24c5e187 519 $ git clean -dxf
8c35d285 520
dc0a4df9 521then configure and build perl so that you have a Makefile and porting tools:
8c35d285 522
52a66c2c 523 $ ./Configure -Dusedevel -des && make
8c35d285 524
dc0a4df9 525=head3 update Module::CoreList
8c35d285 526
1bac61bb 527Update C<Module::CoreList> with module version data for the new release.
bfadf2ba 528
6a958a95 529Note that if this is a MAINT release, you should run the following actions
1bac61bb 530from the maint branch, but commit the C<CoreList.pm> changes in
a9d1f3db
LB
531I<blead> and subsequently cherry-pick any releases since the last
532maint release and then your recent commit. XXX need a better example
bfadf2ba 533
a0db33fe 534F<corelist.pl> uses ftp.funet.fi to verify information about dual-lived
bfadf2ba 535modules on CPAN. It can use a full, local CPAN mirror or fall back
e8c01f92
SH
536to C<wget> or C<curl> to fetch only package metadata remotely. (If you're
537on Win32, then installing Cygwin is one way to have commands like C<wget>
538and C<curl> available.)
bfadf2ba
JV
539
540(If you'd prefer to have a full CPAN mirror, see
541http://www.cpan.org/misc/cpan-faq.html#How_mirror_CPAN)
542
a0db33fe 543Then change to your perl checkout, and if necessary,
bfadf2ba 544
595f83ae 545 $ make
bfadf2ba 546
cacc980b 547If this is not the first update for this version (e.g. if it was updated
81fc59ef 548when the version number was originally bumped), first edit
d5bddf6e 549F<dist/Module-CoreList/lib/Module/CoreList.pm> to delete the existing
2ce7d676
RGS
550entries for this version from the C<%released> and C<%version> hashes:
551they will have a key like C<5.010001> for 5.10.1.
52a66c2c
DM
552
553XXX the edit-in-place functionality of Porting/corelist.pl should
554be fixed to handle this automatically.
555
bf8ea215 556Then, If you have a local CPAN mirror, run:
bfadf2ba 557
bfadf2ba
JV
558 $ ./perl -Ilib Porting/corelist.pl ~/my-cpan-mirror
559
560Otherwise, run:
561
bfadf2ba
JV
562 $ ./perl -Ilib Porting/corelist.pl cpan
563
52a66c2c 564This will chug for a while, possibly reporting various warnings about
2a720090 565badly-indexed CPAN modules unrelated to the modules actually in core.
2ce7d676 566Assuming all goes well, it will update
d5bddf6e 567F<dist/Module-CoreList/lib/Module/CoreList.pm>.
bfadf2ba
JV
568
569Check that file over carefully:
570
d5bddf6e 571 $ git diff dist/Module-CoreList/lib/Module/CoreList.pm
bfadf2ba 572
da571fa1
DR
573=head4 Bump C<$Module::CoreList::VERSION>
574
00c28750 575If necessary, bump C<$Module::CoreList::VERSION> (there's no need to do this for
bfadf2ba
JV
576every RC; in RC1, bump the version to a new clean number that will
577appear in the final release, and leave as-is for the later RCs and final).
9709cbd8
FC
578It may also happen that C<Module::CoreList> has been modified in blead, and
579hence has a new version number already. (But make sure it is not the same
580number as a CPAN release.)
bfadf2ba
JV
581
582Edit the version number in the new C<< 'Module::CoreList' => 'X.YZ' >>
583entry, as that is likely to reflect the previous version number.
584
00c28750
DR
585=head4 Bump version in Module::CoreList F<Changes>
586
cb9af4c0
AB
587Also edit Module::CoreList's new version number in its F<Changes>
588file.
e8c01f92 589
00c28750
DR
590=head4 Add Module::CoreList version bump to perldelta
591
70855f8b
FC
592Add a perldelta entry for the new Module::CoreList version.
593
da571fa1
DR
594=for checklist skip RC
595
48100be1 596=head4 Update C<%Module::CoreList::released> and C<CAVEATS>
da571fa1 597
a0db33fe 598In addition, if this is a final release (rather than a release candidate):
bfadf2ba
JV
599
600=over 4
601
602=item *
603
604Update this version's entry in the C<%released> hash with today's date.
605
606=item *
607
608Make sure that the script has correctly updated the C<CAVEATS> section
609
610=back
611
00c28750
DR
612=head4 Commit Module::CoreList changes
613
bfadf2ba 614Finally, commit the new version of Module::CoreList:
6a958a95 615(unless this is for MAINT; in which case commit it to blead first, then
a0db33fe 616cherry-pick it back).
bfadf2ba 617
770cf6ff 618 $ git commit -m 'Update Module::CoreList for 5.x.y' dist/Module-CoreList/lib/Module/CoreList.pm
bfadf2ba 619
da571fa1 620=for checklist skip RC
dc0a4df9 621
dc0a4df9 622=head3 update perlhist.pod
a0db33fe 623
e8a7a70e 624I<You MUST SKIP this step for a RC release>
a0db33fe 625
e8a7a70e
JV
626Add an entry to F<pod/perlhist.pod> with the release date, e.g.:
627
628 David 5.10.1 2009-Aug-06
a0db33fe
DM
629
630Make sure that the correct pumpking is listed in the left-hand column, and
631if this is the first release under the stewardship of a new pumpking, make
632sure that his or her name is listed in the section entitled
633C<THE KEEPERS OF THE PUMPKIN>.
634
635Be sure to commit your changes:
636
637 $ git commit -m 'add new release to perlhist' pod/perlhist.pod
8c35d285 638
da571fa1 639=for checklist skip BLEAD-POINT
dc0a4df9
DM
640
641=head3 update patchlevel.h
8c35d285 642
6a958a95 643I<You MUST SKIP this step for a BLEAD-POINT release>
d7eb1120 644
a42352ee
DM
645Update F<patchlevel.h> to add a C<-RC1>-or-whatever string; or, if this is
646a final release, remove it. For example:
d7eb1120
DM
647
648 static const char * const local_patches[] = {
649 NULL
650 + ,"RC1"
651 PERL_GIT_UNPUSHED_COMMITS /* do not remove this line */
652
653Be sure to commit your change:
654
655 $ git commit -m 'bump version to RCnnn' patchlevel.h
656
dc0a4df9
DM
657
658=head3 build, test and check a fresh perl
d7eb1120 659
a0db33fe
DM
660Build perl, then make sure it passes its own test suite, and installs:
661
662 $ git clean -xdf
a42352ee
DM
663 $ ./Configure -des -Dprefix=/tmp/perl-5.x.y-pretest
664
665 # or if it's an odd-numbered version:
a0db33fe 666 $ ./Configure -des -Dusedevel -Dprefix=/tmp/perl-5.x.y-pretest
a42352ee 667
a0db33fe
DM
668 $ make test install
669
52a66c2c
DM
670Check that the output of C</tmp/perl-5.x.y-pretest/bin/perl -v> and
671C</tmp/perl-5.x.y-pretest/bin/perl -V> are as expected,
a0db33fe 672especially as regards version numbers, patch and/or RC levels, and @INC
52a66c2c
DM
673paths. Note that as they have been been built from a git working
674directory, they will still identify themselves using git tags and
675commits.
676
677Then delete the temporary installation.
678
dc0a4df9
DM
679
680=head3 push the work so far
52a66c2c 681
a0db33fe
DM
682Push all your recent commits:
683
684 $ git push origin ....
685
96054f12 686
dc0a4df9 687=head3 tag the release
96054f12 688
e8c01f92 689Tag the release (e.g.):
96054f12 690
b6d23947 691 $ git tag v5.11.0 -m "First release of the v5.11 series!"
e8c01f92 692
6a958a95 693It is B<VERY> important that from this point forward, you not push
f662f3b7
JV
694your git changes to the Perl master repository. If anything goes
695wrong before you publish your newly-created tag, you can delete
696and recreate it. Once you push your tag, we're stuck with it
697and you'll need to use a new version number for your release.
698
dc0a4df9
DM
699
700=head3 build the tarball
a0db33fe 701
0dcf3caa 702Before you run the following, you might want to install 7-Zip (the
0dcb816b 703C<p7zip-full> package under Debian or the C<p7zip> port on MacPorts) or
0dcf3caa
LB
704the AdvanceCOMP suite (e.g. the C<advancecomp> package under Debian,
705or the C<advancecomp> port on macports - 7-Zip on Windows is the
706same code as AdvanceCOMP, so Windows users get the smallest files
707first time). These compress about 5% smaller than gzip and bzip2.
708Over the lifetime of your distribution this will save a lot of
709people a small amount of download time and disk space, which adds
710up.
711
8c35d285
JV
712Create a tarball. Use the C<-s> option to specify a suitable suffix for
713the tarball and directory name:
714
715 $ cd root/of/perl/tree
716 $ make distclean
75a012fe
DM
717 $ git clean -xdf # make sure perl and git agree on files
718 $ git status # and there's nothing lying around
8c35d285 719
8c35d285
JV
720 $ perl Porting/makerel -b -s RC1 # for a release candidate
721 $ perl Porting/makerel -b # for a final release
722
723This creates the directory F<../perl-x.y.z-RC1> or similar, copies all
724the MANIFEST files into it, sets the correct permissions on them,
725adds DOS line endings to some, then tars it up as
726F<../perl-x.y.z-RC1.tar.gz>. With C<-b>, it also creates a C<tar.bz2> file.
727
6480287f
MT
728If you're getting your tarball suffixed with -uncommitted and you're sure
729your changes were all committed, you can override the suffix with:
730
731 $ perl Porting/makerel -b -s ''
96054f12 732
8c35d285
JV
733XXX if we go for extra tags and branches stuff, then add the extra details
734here
735
dc0a4df9 736Finally, clean up the temporary directory, e.g.
a42352ee
DM
737
738 $ rm -rf ../perl-x.y.z-RC1
739
dc0a4df9
DM
740
741=head3 test the tarball
742
00c28750 743Once you have a tarball it's time to test the tarball (not the repository).
dc0a4df9 744
00c28750 745=head4 Copy the tarball to a web server
a42352ee 746
8c35d285
JV
747Copy the tarballs (.gz and possibly .bz2) to a web server somewhere you
748have access to.
749
00c28750 750=head4 Download the tarball to another machine
8c35d285
JV
751
752Download the tarball to some other machine. For a release candidate,
753you really want to test your tarball on two or more different platforms
754and architectures. The #p5p IRC channel on irc.perl.org is a good place
755to find willing victims.
756
00c28750 757=head4 Check that F<Configure> works
8c35d285
JV
758
759Check that basic configuration and tests work on each test machine:
760
761 $ ./Configure -des && make all test
f6af4394 762
00c28750 763=head4 Run the test harness and install
f6af4394 764
8c35d285
JV
765Check that the test harness and install work on each test machine:
766
a42352ee 767 $ make distclean
8c35d285 768 $ ./Configure -des -Dprefix=/install/path && make all test_harness install
a42352ee 769 $ cd /install/path
8c35d285 770
00c28750 771=head4 Check C<perl -v> and C<perl -V>
8c35d285
JV
772
773Check that the output of C<perl -v> and C<perl -V> are as expected,
774especially as regards version numbers, patch and/or RC levels, and @INC
775paths.
776
777Note that the results may be different without a F<.git/> directory,
778which is why you should test from the tarball.
779
00c28750 780=head4 Run the Installation Verification Procedure utility
459fc3ca 781
9651cacc 782 $ ./perl utils/perlivp
459fc3ca
DM
783 ...
784 All tests successful.
785 $
786
00c28750 787=head4 Compare the installed paths to the last release
459fc3ca 788
d60a1044
DM
789Compare the pathnames of all installed files with those of the previous
790release (i.e. against the last installed tarball on this branch which you
791have previously verified using this same procedure). In particular, look
792for files in the wrong place, or files no longer included which should be.
793For example, suppose the about-to-be-released version is 5.10.1 and the
794previous is 5.10.0:
795
796 cd installdir-5.10.0/
797 find . -type f | perl -pe's/5\.10\.0/5.10.1/g' | sort > /tmp/f1
798 cd installdir-5.10.1/
799 find . -type f | sort > /tmp/f2
800 diff -u /tmp/f[12]
801
00c28750 802=head4 Test the CPAN client
d60a1044 803
8c35d285
JV
804Bootstrap the CPAN client on the clean install:
805
16c60e4e 806 $ bin/perl -MCPAN -e "shell"
8c35d285 807
16c60e4e
AB
808If you're running this on Win32 you probably also need a set of Unix
809command-line tools available for CPAN to function correctly without
e8c01f92
SH
810Perl alternatives like LWP installed. Cygwin is an obvious choice.)
811
00c28750 812=head4 Install the Inline module and test it
8c35d285 813
a42352ee
DM
814Try installing a popular CPAN module that's reasonably complex and that
815has dependencies; for example:
8c35d285 816
a42352ee
DM
817 CPAN> install Inline
818 CPAN> quit
8c35d285
JV
819
820Check that your perl can run this:
821
16c60e4e 822 $ bin/perl -lwe "use Inline C => q[int f() { return 42;}]; print f"
a42352ee
DM
823 42
824 $
8c35d285 825
00c28750 826=head4 Bootstrap the CPANPLUS client
8c35d285
JV
827
828Bootstrap the CPANPLUS client on the clean install:
829
75a012fe 830 $ bin/cpanp
8c35d285 831
e8c01f92
SH
832(Again, on Win32 you'll need something like Cygwin installed, but make sure
833that you don't end up with its various F<bin/cpan*> programs being found on
834the PATH before those of the Perl that you're trying to test.)
835
00c28750 836=head4 Install the DBI module with CPANPLUS
8c35d285 837
a42352ee
DM
838 CPAN Terminal> i DBI
839 CPAN Terminal> quit
840 $ bin/perl -MDBI -e 1
75a012fe 841 $
8c35d285 842
00c28750 843=head4 Make sure that perlbug works
8c35d285 844
00c28750 845Test L<perlbug> with the following:
47b1f096 846
a14438df 847 $ bin/perlbug
47b1f096
DM
848 ...
849 Subject: test bug report
850 Local perl administrator [yourself]:
851 Editor [vi]:
852 Module:
853 Category [core]:
854 Severity [low]:
855 (edit report)
856 Action (Send/Display/Edit/Subject/Save to File): f
857 Name of file to save message in [perlbug.rep]:
858 Action (Send/Display/Edit/Subject/Save to File): q
859
860and carefully examine the output (in F<perlbug.rep]>), especially
861the "Locally applied patches" section. If everything appears okay, then
75a012fe
DM
862delete the file, and try it again, this time actually submitting the bug
863report. Check that it shows up, then remember to close it!
47b1f096 864
da571fa1 865=for checklist skip BLEAD-POINT
dc0a4df9
DM
866
867=head3 monitor smokes
47b1f096 868
f6af4394
DM
869Wait for the smoke tests to catch up with the commit which this release is
870based on (or at least the last commit of any consequence).
7277a900 871
f6af4394
DM
872Then check that the smoke tests pass (particularly on Win32). If not, go
873back and fix things.
7277a900 874
6a958a95 875Note that for I<BLEAD-POINT> releases this may not be practical. It takes a
1eefd7d5 876long time for the smokers to catch up, especially the Win32
6a958a95
DM
877smokers. This is why we have a RC cycle for I<MAINT> and I<BLEAD-FINAL>
878releases, but for I<BLEAD-POINT> releases sometimes the best you can do is
879to plead with people on IRC to test stuff on their platforms, fire away,
880and then hope for the best.
7277a900 881
dc0a4df9
DM
882
883=head3 upload to PAUSE
7277a900 884
f6af4394 885Once smoking is okay, upload it to PAUSE. This is the point of no return.
db3f805e
JV
886If anything goes wrong after this point, you will need to re-prepare
887a new release with a new minor version or RC number.
888
a14438df
DM
889 https://pause.perl.org/
890
891(Login, then select 'Upload a file to CPAN')
892
45924287
RS
893If your workstation is not connected to a high-bandwidth,
894high-reliability connection to the Internet, you should probably use the
895"GET URL" feature (rather than "HTTP UPLOAD") to have PAUSE retrieve the
896new release from wherever you put it for testers to find it. This will
897eliminate anxious gnashing of teeth while you wait to see if your
89815 megabyte HTTP upload successfully completes across your slow, twitchy
c27b4e97
SH
899cable modem. You can make use of your home directory on dromedary for
900this purpose: F<http://users.perl5.git.perl.org/~USERNAME> maps to
901F</home/USERNAME/public_html>, where F<USERNAME> is your login account
902on dromedary. I<Remember>: if your upload is partially successful, you
903may need to contact a PAUSE administrator or even bump the version of perl.
45924287 904
a42352ee 905Upload both the .gz and .bz2 versions of the tarball.
f6af4394 906
38195a8c
DG
907Do not proceed any further until you are sure that your tarballs are on
908CPAN. Check your authors directory on one of the "fast" CPAN mirrors
b28f69c2 909(e.g., cpan.hexten.net
38195a8c 910or cpan.cpantesters.org) to confirm that your uploads have been successful.
c27b4e97 911
00c28750
DR
912=for checklist skip RC
913
914=head3 wait for indexing
915
76526317
FR
916I<You MUST SKIP this step for RC>
917
918Wait until you receive notification emails from the PAUSE indexer
919confirming that your uploads have been received. IMPORTANT -- you will
920probably get an email that indexing has failed, due to module permissions.
921This is considered normal.
922
dc0a4df9
DM
923
924=head3 publish tag
210de33e 925
f662f3b7 926Now that you've shipped the new perl release to PAUSE, it's
e8c01f92 927time to publish the tag you created earlier to the public git repo (e.g.):
f662f3b7
JV
928
929 $ git push origin tag v5.11.0
f6af4394 930
da571fa1 931=for checklist skip BLEAD-POINT
dc0a4df9
DM
932
933=head3 disarm patchlevel.h
f6af4394 934
6a958a95 935I<You MUST SKIP this step for BLEAD-POINT release>
113f3f4c 936
a42352ee 937Disarm the F<patchlevel.h> change; for example,
d7eb1120
DM
938
939 static const char * const local_patches[] = {
940 NULL
941 - ,"RC1"
942 PERL_GIT_UNPUSHED_COMMITS /* do not remove this line */
943
944Be sure to commit your change:
945
946 $ git commit -m 'disarm RCnnn bump' patchlevel.h
a14438df 947 $ git push origin ....
d7eb1120 948
2e831dfd 949
dc0a4df9
DM
950
951=head3 announce to p5p
2e831dfd 952
db3f805e 953Mail p5p to announce your new release, with a quote you prepared earlier.
f6af4394 954
098d30ef 955Use the template at Porting/release_announcement_template.txt
dc0a4df9
DM
956
957=head3 update epigraphs.pod
f6af4394 958
85531b0a 959Add your quote to F<Porting/epigraphs.pod> and commit it.
606d51b7
Z
960Your release announcement will probably not have reached the web-visible
961archives yet, so you won't be able to include the customary link to the
962release announcement yet.
dc0a4df9 963
b02b3ec7
DR
964=head3 blog about your epigraph
965
966If you have a blog, please consider writing an entry in your blog explaining
967why you chose that particular quote for your epigraph.
968
da571fa1
DR
969=for checklist skip RC
970
dc0a4df9 971=head3 Module::CoreList nagging
85531b0a 972
bc4c40f2 973I<You MUST SKIP this step for RC>
8c35d285 974
75a012fe
DM
975Remind the current maintainer of C<Module::CoreList> to push a new release
976to CPAN.
7277a900 977
da571fa1 978=for checklist skip RC
dc0a4df9
DM
979
980=head3 new perldelta
a2cba4bc 981
bc4c40f2 982I<You MUST SKIP this step for RC>
7277a900 983
bcfe7366 984Create a new perldelta.
5ef3945b 985
bcfe7366 986=over 4
8e967a1c 987
bcfe7366 988=item *
8e967a1c 989
bcfe7366 990Confirm that you have a clean checkout with no local changes.
c5b87fed 991
bcfe7366 992=item *
17163f85 993
bcfe7366 994Run F<Porting/new-perldelta.pl>
8e967a1c 995
bcfe7366 996=item *
17163f85 997
bcfe7366 998Run the C<git add> commands it outputs to add new and modified files.
7277a900 999
bcfe7366 1000=item *
7277a900 1001
bcfe7366 1002Verify that the build still works, by running C<./Configure> and
fd76d40d
SH
1003C<make test_porting>. (On Win32, run C<nmake> and
1004C<nmake test TEST_FILES="porting\*.t ..\lib\diagnostics.t">.)
17163f85 1005
bcfe7366 1006=item *
17163f85 1007
bcfe7366
NC
1008If F<t/porting/podcheck.t> spots errors in the new F<pod/perldelta.pod>,
1009run C<./perl -MTestInit t/porting/podcheck.t | less> for more detail.
1010Skip to the end of its test output to see the options it offers you.
57433fbf 1011
bcfe7366 1012=item *
75a012fe 1013
bcfe7366 1014When C<make test_porting> passes, commit the new perldelta.
75a012fe 1015
bcfe7366 1016=back
75a012fe 1017
21768cb3 1018At this point you may want to compare the commit with a previous bump to
fd76d40d 1019see if they look similar. See commit e3c71926d3 for an example of a
75a012fe 1020previous version bump.
57433fbf 1021
da571fa1 1022=for checklist skip BLEAD-POINT MAINT RC
dc0a4df9
DM
1023
1024=head3 bump version
57433fbf 1025
6a958a95 1026I<You MUST SKIP this step for RC, BLEAD-POINT, MAINT>
dc0a62a1 1027
6a958a95
DM
1028If this was a BLEAD-FINAL release (i.e. the first release of a new maint
1029series, 5.x.0 where x is even), then bump the version in the blead branch
1030in git, e.g. 5.12.0 to 5.13.0.
17163f85 1031
6d5e92cd
FC
1032First, add a new feature bundle to F<regen/feature.pl>, initially by just
1033copying the exiting entry, and bump the file's $VERSION (after the __END__
1034marker); e.g.
17163f85
DM
1035
1036 "5.14" => [qw(switch say state unicode_strings)],
1037 + "5.15" => [qw(switch say state unicode_strings)],
addebd58 1038
57fef7cc
FC
1039Run F<regen/feature.pl> to propagate the changes to F<lib/feature.pm>.
1040
dc0a4df9
DM
1041Then follow the section L<"Bump the version number"> to bump the version
1042in the remaining files and test and commit.
17163f85 1043
17163f85 1044
d5c37431
NC
1045=head3 clean build and test
1046
1047Run a clean build and test to make sure nothing obvious is broken.
1048
1049In particular, F<Porting/perldelta_template.pod> is intentionally exempted
1050from podchecker tests, to avoid false positives about placeholder text.
1051However, once it's copied to F<pod/perldelta.pod> the contents can now
ef4474b5
KW
1052cause test failures. Problems should resolved by doing one of the
1053following:
1054
1055=over
1056
1057=item 1
1058
1059Replace placeholder text with correct text.
1060
1061=item 2
1062
1063If the problem is from a broken placeholder link, you can add it to the
1064array C<@perldelta_ignore_links> in F<t/porting/podcheck.t>. Lines
1065containing such links should be marked with C<XXX> so that they get
1066cleaned up before the next release.
1067
1068=item 3
1069
1070Following the instructions output by F<t/porting/podcheck.t> on how to
1071update its exceptions database.
1072
1073=back
d5c37431 1074
dc0a4df9
DM
1075=head3 push commits
1076
1077Finally, push any commits done above.
1078
1079 $ git push origin ....
1080
da571fa1 1081=for checklist skip BLEAD-POINT MAINT RC
dc0a4df9
DM
1082
1083=head3 create maint branch
17163f85 1084
6a958a95 1085I<You MUST SKIP this step for RC, BLEAD-POINT, MAINT>
17163f85 1086
6a958a95
DM
1087If this was a BLEAD-FINAL release (i.e. the first release of a new maint
1088series, 5.x.0 where x is even), then create a new maint branch based on
1089the commit tagged as the current release.
7277a900 1090
233ca920
JV
1091Assuming you're using git 1.7.x or newer:
1092
17163f85 1093 $ git checkout -b maint-5.12 v5.12.0
233ca920 1094 $ git push origin -u maint-5.12
addebd58 1095
dc0a4df9 1096
da571fa1
DR
1097=for checklist skip BLEAD-POINT MAINT RC
1098
d5722260
DK
1099=head3 make the maint branch available in the APC
1100
1101Clone the new branch into /srv/gitcommon/branches on camel so the APC will
1102receive its changes.
1103
07697565 1104 $ git clone --branch maint-5.14 /gitroot/perl.git \
d5722260 1105 ? /srv/gitcommon/branches/perl-5.14.x
07697565 1106 $ chmod -R g=u /srv/gitcommon/branches/perl-5.14.x
d5722260
DK
1107
1108And nag the sysadmins to make this directory available via rsync.
1109
da571fa1 1110=for checklist skip BLEAD-POINT RC
d5722260 1111
dc0a4df9 1112=head3 copy perldelta.pod to other branches
addebd58 1113
6a958a95 1114I<You MUST SKIP this step for RC, BLEAD-POINT>
8c35d285 1115
c5b87fed 1116Copy the perldelta.pod for this release into the other branches; for
75a012fe 1117example:
7277a900 1118
c5b87fed 1119 $ cp -i ../5.10.x/pod/perldelta.pod pod/perl5101delta.pod # for example
75a012fe
DM
1120 $ git add pod/perl5101delta.pod
1121
0aef0fe5 1122Edit F<pod/perl.pod> to add an entry for the file, e.g.:
75a012fe
DM
1123
1124 perl5101delta Perl changes in version 5.10.1
bc4c40f2 1125
75a012fe 1126Then rebuild various files:
7277a900 1127
75a012fe
DM
1128 $ perl pod/buildtoc --build-all
1129
1130Finally, commit:
1131
1132 $ git commit -a -m 'add perlXXXdelta'
7277a900 1133
dc0a4df9
DM
1134
1135=head3 update perlhist.pod in other branches
7277a900 1136
f6af4394 1137Make sure any recent F<pod/perlhist.pod> entries are copied to
e8a7a70e 1138F<perlhist.pod> on other branches
f6af4394 1139e.g.
7277a900 1140
f6af4394 1141 5.8.9 2008-Dec-14
7277a900 1142
dc0a4df9
DM
1143
1144=head3 bump RT version number
6e40fbf9 1145
7c139051
DR
1146Log into http://rt.perl.org/ and check whether the new version is in the RT
1147fields C<Perl Version> and C<Fixed In>. The easiest way to determine this is
1148to go to L<https://rt.perl.org/rt3/Search/Build.html> and click on the drop
1149downs next to the C<Perl Version> and C<Fixed In> labels.
1150
1151If the new version is not listed there, send an email to C<perlbug-admin at
1152perl.org> requesting this.
dc0a4df9
DM
1153
1154=head3 Relax!
a3738a12 1155
bc4c40f2
JV
1156I<You MUST RETIRE to your preferred PUB, CAFE or SEASIDE VILLA for some
1157much-needed rest and relaxation>.
8c35d285
JV
1158
1159Thanks for releasing perl!
1160
7277a900 1161
b28f69c2
Z
1162=head2 Building a release - the day after
1163
606d51b7
Z
1164=head3 link announcement in epigraphs.pod
1165
1166Add, to your quote to F<Porting/epigraphs.pod>, a link to the release
1167announcement in the web-visible mailing list archive. Commit it.
1168
dc0a4df9
DM
1169=head3 check tarball availability
1170
1171Check various website entries to make sure the that tarball has appeared
1172and is properly indexed:
1173
b28f69c2
Z
1174=over 4
1175
1176=item *
1177
98df743a
Z
1178Check your author directory under L<http://www.cpan.org/authors/id/>
1179to ensure that the tarballs are available on the website.
b28f69c2
Z
1180
1181=item *
1182
98df743a
Z
1183Check C</src> on CPAN (on a fast mirror) to ensure that links to
1184the new tarballs have appeared. There should be links in C</src/5.0>
1185(which is accumulating all new versions), links in C</src> (which shows
1186only the latest version on each branch), and an appropriate mention in
1187C</src/README.html> (which describes the latest versions).
1188
1189These links should appear automatically, some hours after upload.
1190If they don't, or the C<README.html> description is inadequate,
1191ask Ask <ask@perl.org>.
b28f69c2
Z
1192
1193=item *
1194
98df743a
Z
1195Check L<http://www.cpan.org/src/> to ensure that the C</src> updates
1196have been correctly mirrored to the website.
1197If they haven't, ask Ask <ask@perl.org>.
1198
1199=item *
b28f69c2 1200
98df743a
Z
1201Check L<http://search.cpan.org> to see if it has indexed the distribution.
1202It should be visible at a URL like C<http://search.cpan.org/dist/perl-5.10.1/>.
b28f69c2 1203
dc0a4df9 1204=back
b28f69c2 1205
e7b51df1 1206=for checklist skip RC
dc0a4df9
DM
1207
1208=head3 update dev.perl.org
1209
e7b51df1 1210I<You MUST SKIP this step for a RC release>
98df743a 1211
a6836307 1212In the C<perlorg> repository, edit F<docs/dev/perl5/index.html>
845a9291
MM
1213to link to this new release. Then make a pull request to Leo Lapworth.
1214If this fails for some reason and you cannot cajole anybody else into
1215submitting that change, you can mail Leo as last resort.
b28f69c2 1216
da571fa1 1217=for checklist end
b28f69c2 1218
7277a900
GS
1219=head1 SOURCE
1220
f6af4394
DM
1221Based on
1222http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/2009-05/msg00608.html,
1223plus a whole bunch of other sources, including private correspondence.
7277a900
GS
1224
1225=cut
1226