This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Update Porting/checkAUTHORS.pl after commit 6410892abe3d820a.
[perl5.git] / pod / perldelta.pod
CommitLineData
44691e6f
AB
1=encoding utf8
2
3=head1 NAME
4
5438d4b8
Z
5[ this is a template for a new perldelta file. Any text flagged as
6XXX needs to be processed before release. ]
f5938650 7
5438d4b8 8perldelta - what is new for perl v5.15.2
760696b8 9
5438d4b8 10=head1 DESCRIPTION
5cd408a2 11
5438d4b8
Z
12This document describes differences between the 5.15.1 release and
13the 5.15.2 release.
5cd408a2 14
5438d4b8
Z
15If you are upgrading from an earlier release such as 5.15.0, first read
16L<perl5151delta>, which describes differences between 5.15.0 and
175.15.1.
062678b2 18
5438d4b8 19=head1 Notice
062678b2 20
5438d4b8 21XXX Any important notices here
4185c919 22
5438d4b8 23=head1 Core Enhancements
4185c919 24
5438d4b8
Z
25XXX New core language features go here. Summarise user-visible core language
26enhancements. Particularly prominent performance optimisations could go
27here, but most should go in the L</Performance Enhancements> section.
82aed44a 28
5438d4b8 29[ List each enhancement as a =head2 entry ]
82aed44a 30
5438d4b8 31=head1 Security
2b679393 32
5438d4b8
Z
33XXX Any security-related notices go here. In particular, any security
34vulnerabilities closed should be noted here rather than in the
35L</Selected Bug Fixes> section.
2b679393 36
5438d4b8 37[ List each security issue as a =head2 entry ]
7818c927 38
5438d4b8 39=head1 Incompatible Changes
7818c927 40
5438d4b8 41XXX For a release on a stable branch, this section aspires to be:
760696b8 42
5438d4b8
Z
43 There are no changes intentionally incompatible with 5.XXX.XXX
44 If any exist, they are bugs and reports are welcome.
6693394d 45
5438d4b8 46[ List each incompatible change as a =head2 entry ]
6693394d 47
5438d4b8 48=head1 Deprecations
92c695db 49
5438d4b8
Z
50XXX Any deprecated features, syntax, modules etc. should be listed here.
51In particular, deprecated modules should be listed here even if they are
52listed as an updated module in the L</Modules and Pragmata> section.
92c695db 53
5438d4b8 54[ List each deprecation as a =head2 entry ]
6693394d 55
5438d4b8 56=head1 Performance Enhancements
bfafcb9a 57
5438d4b8
Z
58XXX Changes which enhance performance without changing behaviour go here. There
59may well be none in a stable release.
bfafcb9a 60
5438d4b8 61[ List each enhancement as a =item entry ]
72de20cd 62
5438d4b8 63=over 4
72de20cd 64
93905212
FC
65=item *
66
5438d4b8 67XXX
93905212 68
6693394d
FC
69=back
70
0890f1a5 71=head1 Modules and Pragmata
bdb9ba77 72
5438d4b8
Z
73XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
74go here. If Module::CoreList is updated, generate an initial draft of the
75following sections using F<Porting/corelist-perldelta.pl>, which prints stub
76entries to STDOUT. Results can be pasted in place of the '=head2' entries
77below. A paragraph summary for important changes should then be added by hand.
78In an ideal world, dual-life modules would have a F<Changes> file that could be
79cribbed.
80
81[ Within each section, list entries as a =item entry ]
82
0890f1a5 83=head2 New Modules and Pragmata
6693394d 84
0890f1a5 85=over 4
6693394d
FC
86
87=item *
88
5438d4b8 89XXX
6693394d
FC
90
91=back
92
0890f1a5 93=head2 Updated Modules and Pragmata
760696b8 94
0890f1a5 95=over 4
760696b8
FC
96
97=item *
98
57126352
DG
99L<ExtUtils::Install> has been upgraded from version 1.56 to version 1.57.
100
101There is no change to ExtUtils::Install other than the version number
102increase, but L<ExtUtils::Installed> has been upgraded from version 1.999_001
c493c0a1 103to version 1.999002 and a new C<skip_cwd> attribute has been added.
259925f6 104
6252d2e2
NC
105=item *
106
107L<PerlIO::via> has been upgraded from version 0.11 to 0.12.
108
109The only change is a correction in the documentation.
110
5438d4b8 111=back
77ccfaeb 112
5438d4b8 113=head2 Removed Modules and Pragmata
508236ce 114
5438d4b8 115=over 4
508236ce
CBW
116
117=item *
118
5438d4b8 119XXX
c69a30ec 120
5438d4b8 121=back
c69a30ec 122
5438d4b8 123=head1 Documentation
c69a30ec 124
5438d4b8
Z
125XXX Changes to files in F<pod/> go here. Consider grouping entries by
126file and be sure to link to the appropriate page, e.g. L<perlfunc>.
7c420290 127
5438d4b8 128=head2 New Documentation
7c420290 129
5438d4b8 130XXX Changes which create B<new> files in F<pod/> go here.
0cb4637e 131
5438d4b8 132=head3 L<XXX>
7818c927 133
5438d4b8 134XXX Description of the purpose of the new file here
7818c927 135
5438d4b8 136=head2 Changes to Existing Documentation
dd413713 137
5438d4b8
Z
138XXX Changes which significantly change existing files in F<pod/> go here.
139However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
140section.
7818c927 141
5438d4b8 142=head3 L<XXX>
7818c927 143
5438d4b8 144=over 4
7818c927
FC
145
146=item *
147
5438d4b8 148XXX Description of the change here
5aeca1f7 149
5438d4b8 150=back
5aeca1f7 151
5438d4b8 152=head1 Diagnostics
0cb4637e 153
5438d4b8
Z
154The following additions or changes have been made to diagnostic output,
155including warnings and fatal error messages. For the complete list of
156diagnostic messages, see L<perldiag>.
0cb4637e 157
5438d4b8
Z
158XXX New or changed warnings emitted by the core's C<C> code go here. Also
159include any changes in L<perldiag> that reconcile it to the C<C> code.
00f02a57 160
5438d4b8
Z
161[ Within each section, list entries as a =item entry that links to perldiag,
162 e.g.
00f02a57 163
5438d4b8 164 =item *
00f02a57 165
5438d4b8
Z
166 L<Invalid version object|perldiag/"Invalid version object">
167]
8b00e523 168
5438d4b8 169=head2 New Diagnostics
4abaf918 170
5438d4b8 171XXX Newly added diagnostic messages go here
4abaf918 172
5438d4b8 173=head3 New Errors
4abaf918 174
5438d4b8 175=over 4
4abaf918
Z
176
177=item *
178
5438d4b8 179XXX L<message|perldiag/"message">
8b00e523 180
e8e35311
FC
181=back
182
5438d4b8 183=head3 New Warnings
bdb9ba77 184
0890f1a5 185=over 4
bdb9ba77
DG
186
187=item *
188
5438d4b8 189XXX L<message|perldiag/"message">
bdb9ba77
DG
190
191=back
192
5438d4b8 193=head2 Changes to Existing Diagnostics
7818c927 194
5438d4b8 195XXX Changes (i.e. rewording) of diagnostic messages go here
0890f1a5 196
0890f1a5 197=over 4
6693394d
FC
198
199=item *
200
5438d4b8 201XXX Describe change here
259925f6 202
5438d4b8 203=back
7818c927 204
5438d4b8 205=head1 Utility Changes
7818c927 206
5438d4b8
Z
207XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go
208here. Most of these are built within the directories F<utils> and F<x2p>.
7818c927 209
5438d4b8
Z
210[ List utility changes as a =head3 entry for each utility and =item
211entries for each change
212Use L<XXX> with program names to get proper documentation linking. ]
7818c927 213
71449ad0 214=head3 L<perlivp>
b908e258 215
5438d4b8 216=over 4
b908e258
Z
217
218=item *
219
71449ad0
DG
220Fixed a bug whereby other perls under the current directory could cause
221false positive failures.
222
223=item *
224
225Tests for .ph files have been removed, as these test have been optional since
2262005 and .ph files are no longer generated during installation.
b908e258 227
6693394d
FC
228=back
229
5438d4b8 230=head1 Configuration and Compilation
b7188eb5 231
5438d4b8
Z
232XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
233go here. Any other changes to the Perl build process should be listed here.
234However, any platform-specific changes should be listed in the
235L</Platform Support> section, instead.
44691e6f 236
5438d4b8 237[ List changes as a =item entry ].
42a91c97 238
34dc2ec0 239=over 4
42a91c97 240
6693394d 241=item *
42a91c97 242
5438d4b8 243XXX
42a91c97 244
34dc2ec0 245=back
42a91c97 246
0890f1a5 247=head1 Testing
bdab33d1 248
5438d4b8
Z
249XXX Any significant changes to the testing of a freshly built perl should be
250listed here. Changes which create B<new> files in F<t/> go here as do any
251large changes to the testing harness (e.g. when parallel testing was added).
252Changes to existing files in F<t/> aren't worth summarising, although the bugs
253that they represent may be covered elsewhere.
f5938650 254
5438d4b8 255[ List each test improvement as a =item entry ]
1fcb0052 256
5438d4b8 257=over 4
1fcb0052 258
b908e258
Z
259=item *
260
5438d4b8 261XXX
b908e258 262
f5938650 263=back
2fbb14a0 264
0890f1a5 265=head1 Platform Support
975dff8c 266
5438d4b8 267XXX Any changes to platform support should be listed in the sections below.
6693394d 268
5438d4b8
Z
269[ Within the sections, list each platform as a =item entry with specific
270changes as paragraphs below it. ]
6693394d 271
5438d4b8 272=head2 New Platforms
1fcb0052 273
5438d4b8
Z
274XXX List any platforms that this version of perl compiles on, that previous
275versions did not. These will either be enabled by new files in the F<hints/>
276directories, or new subdirectories and F<README> files at the top level of the
277source tree.
6693394d 278
0890f1a5 279=over 4
f5938650 280
5438d4b8 281=item XXX-some-platform
c62f68e3 282
5438d4b8 283XXX
f5938650 284
0890f1a5 285=back
25aa614d 286
5438d4b8 287=head2 Discontinued Platforms
87d00a71 288
5438d4b8 289XXX List any platforms that this version of perl no longer compiles on.
87d00a71 290
5438d4b8 291=over 4
da507230 292
5438d4b8 293=item XXX-some-platform
fff96ff7 294
5438d4b8 295XXX
da507230 296
5438d4b8 297=back
bb3abb05 298
5438d4b8 299=head2 Platform-Specific Notes
d25b0d7b 300
5438d4b8
Z
301XXX List any changes for specific platforms. This could include configuration
302and compilation changes or changes in portability/compatibility. However,
303changes within modules for platforms should generally be listed in the
304L</Modules and Pragmata> section.
d25b0d7b 305
5438d4b8 306=over 4
4bee03f8 307
5438d4b8 308=item XXX-some-platform
4bee03f8 309
5438d4b8 310XXX
d9463c66 311
5438d4b8 312=back
d9463c66 313
5438d4b8 314=head1 Internal Changes
7c4c6e7c 315
5438d4b8
Z
316XXX Changes which affect the interface available to C<XS> code go here.
317Other significant internal changes for future core maintainers should
318be noted as well.
7c4c6e7c 319
5438d4b8 320[ List each change as a =item entry ]
777d9014 321
5438d4b8 322=over 4
95f7e41f
FC
323
324=item *
325
5438d4b8 326XXX
df5b44bd 327
5438d4b8 328=back
df5b44bd 329
5438d4b8 330=head1 Selected Bug Fixes
e22e289d 331
5438d4b8
Z
332XXX Important bug fixes in the core language are summarised here.
333Bug fixes in files in F<ext/> and F<lib/> are best summarised in
334L</Modules and Pragmata>.
7818c927 335
5438d4b8 336[ List each fix as a =item entry ]
7818c927 337
5438d4b8 338=over 4
7818c927
FC
339
340=item *
341
f4df43b5
FC
342Locking an lvalue subroutine (via C<lock &lvsub>) now locks the return
343value, instead of trying to lock the sub (which has no effect). It also no
344longer tries to return the sub as a scalar, resulting in strange side
345effects like C<ref \$_> returning "CODE" in some instances.
7818c927 346
3fdd840f
FC
347=item *
348
349C<lock>'s prototype has been corrected to C<(\[$@%*])> from C<(\$)>, which
350was just wrong.
351
5438d4b8 352=back
c62f68e3 353
5438d4b8 354=head1 Known Problems
c62f68e3 355
5438d4b8
Z
356XXX Descriptions of platform agnostic bugs we know we can't fix go here. Any
357tests that had to be C<TODO>ed for the release would be noted here, unless
358they were specific to a particular platform (see below).
c62f68e3 359
5438d4b8
Z
360This is a list of some significant unfixed bugs, which are regressions
361from either 5.XXX.XXX or 5.XXX.XXX.
e22e289d 362
5438d4b8 363[ List each fix as a =item entry ]
e22e289d 364
5438d4b8 365=over 4
e22e289d 366
b908e258
Z
367=item *
368
5438d4b8 369XXX
4ec40670 370
5438d4b8 371=back
4ec40670 372
5438d4b8 373=head1 Obituary
b908e258 374
5438d4b8
Z
375XXX If any significant core contributor has died, we've added a short obituary
376here.
42a91c97 377
44691e6f
AB
378=head1 Acknowledgements
379
f1c1ecab 380XXX Generate this with:
5438d4b8
Z
381
382 perl Porting/acknowledgements.pl v5.15.1..HEAD
29cf780c 383
44691e6f
AB
384=head1 Reporting Bugs
385
386If you find what you think is a bug, you might check the articles
34dc2ec0 387recently posted to the comp.lang.perl.misc newsgroup and the perl
44691e6f
AB
388bug database at http://rt.perl.org/perlbug/ . There may also be
389information at http://www.perl.org/ , the Perl Home Page.
390
391If you believe you have an unreported bug, please run the L<perlbug>
392program included with your release. Be sure to trim your bug down
393to a tiny but sufficient test case. Your bug report, along with the
394output of C<perl -V>, will be sent off to perlbug@perl.org to be
395analysed by the Perl porting team.
396
397If the bug you are reporting has security implications, which make it
398inappropriate to send to a publicly archived mailing list, then please send
34dc2ec0 399it to perl5-security-report@perl.org. This points to a closed subscription
b4707b2a
FC
400unarchived mailing list, which includes
401all the core committers, who will be able
44691e6f
AB
402to help assess the impact of issues, figure out a resolution, and help
403co-ordinate the release of patches to mitigate or fix the problem across all
34dc2ec0
DM
404platforms on which Perl is supported. Please only use this address for
405security issues in the Perl core, not for modules independently
44691e6f
AB
406distributed on CPAN.
407
408=head1 SEE ALSO
409
410The F<Changes> file for an explanation of how to view exhaustive details
411on what changed.
412
413The F<INSTALL> file for how to build Perl.
414
415The F<README> file for general stuff.
416
417The F<Artistic> and F<Copying> files for copyright information.
418
419=cut