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