This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
perldiag: Add missing variant of proto warning
[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
5213914c 107L<PerlIO::via> has been upgraded from version 0.11 to version 0.12.
6252d2e2
NC
108
109The only change is a correction in the documentation.
110
5213914c
CBW
111=item *
112
113L<Term::ANSIColor> has been upgraded from version 3.00 to version 3.01
114
115Only interpret an initial array reference as a list of colors, not any initial
116reference, allowing the colored function to work properly on objects with
117stringification defined.
118
5438d4b8 119=back
77ccfaeb 120
5438d4b8 121=head2 Removed Modules and Pragmata
508236ce 122
5438d4b8 123=over 4
508236ce
CBW
124
125=item *
126
5438d4b8 127XXX
c69a30ec 128
5438d4b8 129=back
c69a30ec 130
5438d4b8 131=head1 Documentation
c69a30ec 132
5438d4b8
Z
133XXX Changes to files in F<pod/> go here. Consider grouping entries by
134file and be sure to link to the appropriate page, e.g. L<perlfunc>.
7c420290 135
5438d4b8 136=head2 New Documentation
7c420290 137
5438d4b8 138XXX Changes which create B<new> files in F<pod/> go here.
0cb4637e 139
5438d4b8 140=head3 L<XXX>
7818c927 141
5438d4b8 142XXX Description of the purpose of the new file here
7818c927 143
5438d4b8 144=head2 Changes to Existing Documentation
dd413713 145
5438d4b8
Z
146XXX Changes which significantly change existing files in F<pod/> go here.
147However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
148section.
7818c927 149
5438d4b8 150=head3 L<XXX>
7818c927 151
5438d4b8 152=over 4
7818c927
FC
153
154=item *
155
5438d4b8 156XXX Description of the change here
5aeca1f7 157
5438d4b8 158=back
5aeca1f7 159
5438d4b8 160=head1 Diagnostics
0cb4637e 161
5438d4b8
Z
162The following additions or changes have been made to diagnostic output,
163including warnings and fatal error messages. For the complete list of
164diagnostic messages, see L<perldiag>.
0cb4637e 165
5438d4b8
Z
166XXX New or changed warnings emitted by the core's C<C> code go here. Also
167include any changes in L<perldiag> that reconcile it to the C<C> code.
00f02a57 168
5438d4b8
Z
169[ Within each section, list entries as a =item entry that links to perldiag,
170 e.g.
00f02a57 171
5438d4b8 172 =item *
00f02a57 173
5438d4b8
Z
174 L<Invalid version object|perldiag/"Invalid version object">
175]
8b00e523 176
5438d4b8 177=head2 New Diagnostics
4abaf918 178
5438d4b8 179XXX Newly added diagnostic messages go here
4abaf918 180
5438d4b8 181=head3 New Errors
4abaf918 182
5438d4b8 183=over 4
4abaf918
Z
184
185=item *
186
5438d4b8 187XXX L<message|perldiag/"message">
8b00e523 188
e8e35311
FC
189=back
190
5438d4b8 191=head3 New Warnings
bdb9ba77 192
0890f1a5 193=over 4
bdb9ba77
DG
194
195=item *
196
5438d4b8 197XXX L<message|perldiag/"message">
bdb9ba77
DG
198
199=back
200
5438d4b8 201=head2 Changes to Existing Diagnostics
7818c927 202
5438d4b8 203XXX Changes (i.e. rewording) of diagnostic messages go here
0890f1a5 204
0890f1a5 205=over 4
6693394d
FC
206
207=item *
208
5438d4b8 209XXX Describe change here
259925f6 210
5438d4b8 211=back
7818c927 212
5438d4b8 213=head1 Utility Changes
7818c927 214
5438d4b8
Z
215XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go
216here. Most of these are built within the directories F<utils> and F<x2p>.
7818c927 217
5438d4b8
Z
218[ List utility changes as a =head3 entry for each utility and =item
219entries for each change
220Use L<XXX> with program names to get proper documentation linking. ]
7818c927 221
71449ad0 222=head3 L<perlivp>
b908e258 223
5438d4b8 224=over 4
b908e258
Z
225
226=item *
227
71449ad0
DG
228Fixed a bug whereby other perls under the current directory could cause
229false positive failures.
230
231=item *
232
233Tests for .ph files have been removed, as these test have been optional since
2342005 and .ph files are no longer generated during installation.
b908e258 235
6693394d
FC
236=back
237
5438d4b8 238=head1 Configuration and Compilation
b7188eb5 239
5438d4b8
Z
240XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
241go here. Any other changes to the Perl build process should be listed here.
242However, any platform-specific changes should be listed in the
243L</Platform Support> section, instead.
44691e6f 244
5438d4b8 245[ List changes as a =item entry ].
42a91c97 246
34dc2ec0 247=over 4
42a91c97 248
6693394d 249=item *
42a91c97 250
5438d4b8 251XXX
42a91c97 252
34dc2ec0 253=back
42a91c97 254
0890f1a5 255=head1 Testing
bdab33d1 256
5438d4b8
Z
257XXX Any significant changes to the testing of a freshly built perl should be
258listed here. Changes which create B<new> files in F<t/> go here as do any
259large changes to the testing harness (e.g. when parallel testing was added).
260Changes to existing files in F<t/> aren't worth summarising, although the bugs
261that they represent may be covered elsewhere.
f5938650 262
5438d4b8 263[ List each test improvement as a =item entry ]
1fcb0052 264
5438d4b8 265=over 4
1fcb0052 266
b908e258
Z
267=item *
268
5438d4b8 269XXX
b908e258 270
f5938650 271=back
2fbb14a0 272
0890f1a5 273=head1 Platform Support
975dff8c 274
5438d4b8 275XXX Any changes to platform support should be listed in the sections below.
6693394d 276
5438d4b8
Z
277[ Within the sections, list each platform as a =item entry with specific
278changes as paragraphs below it. ]
6693394d 279
5438d4b8 280=head2 New Platforms
1fcb0052 281
5438d4b8
Z
282XXX List any platforms that this version of perl compiles on, that previous
283versions did not. These will either be enabled by new files in the F<hints/>
284directories, or new subdirectories and F<README> files at the top level of the
285source tree.
6693394d 286
0890f1a5 287=over 4
f5938650 288
5438d4b8 289=item XXX-some-platform
c62f68e3 290
5438d4b8 291XXX
f5938650 292
0890f1a5 293=back
25aa614d 294
5438d4b8 295=head2 Discontinued Platforms
87d00a71 296
5438d4b8 297XXX List any platforms that this version of perl no longer compiles on.
87d00a71 298
5438d4b8 299=over 4
da507230 300
5438d4b8 301=item XXX-some-platform
fff96ff7 302
5438d4b8 303XXX
da507230 304
5438d4b8 305=back
bb3abb05 306
5438d4b8 307=head2 Platform-Specific Notes
d25b0d7b 308
5438d4b8
Z
309XXX List any changes for specific platforms. This could include configuration
310and compilation changes or changes in portability/compatibility. However,
311changes within modules for platforms should generally be listed in the
312L</Modules and Pragmata> section.
d25b0d7b 313
5438d4b8 314=over 4
4bee03f8 315
5438d4b8 316=item XXX-some-platform
4bee03f8 317
5438d4b8 318XXX
d9463c66 319
5438d4b8 320=back
d9463c66 321
5438d4b8 322=head1 Internal Changes
7c4c6e7c 323
5438d4b8
Z
324XXX Changes which affect the interface available to C<XS> code go here.
325Other significant internal changes for future core maintainers should
326be noted as well.
7c4c6e7c 327
5438d4b8 328[ List each change as a =item entry ]
777d9014 329
5438d4b8 330=over 4
95f7e41f
FC
331
332=item *
333
5438d4b8 334XXX
df5b44bd 335
5438d4b8 336=back
df5b44bd 337
5438d4b8 338=head1 Selected Bug Fixes
e22e289d 339
5438d4b8
Z
340XXX Important bug fixes in the core language are summarised here.
341Bug fixes in files in F<ext/> and F<lib/> are best summarised in
342L</Modules and Pragmata>.
7818c927 343
5438d4b8 344[ List each fix as a =item entry ]
7818c927 345
5438d4b8 346=over 4
7818c927
FC
347
348=item *
349
f4df43b5
FC
350Locking an lvalue subroutine (via C<lock &lvsub>) now locks the return
351value, instead of trying to lock the sub (which has no effect). It also no
352longer tries to return the sub as a scalar, resulting in strange side
353effects like C<ref \$_> returning "CODE" in some instances.
7818c927 354
3fdd840f
FC
355=item *
356
357C<lock>'s prototype has been corrected to C<(\[$@%*])> from C<(\$)>, which
358was just wrong.
359
5438d4b8 360=back
c62f68e3 361
5438d4b8 362=head1 Known Problems
c62f68e3 363
5438d4b8
Z
364XXX Descriptions of platform agnostic bugs we know we can't fix go here. Any
365tests that had to be C<TODO>ed for the release would be noted here, unless
366they were specific to a particular platform (see below).
c62f68e3 367
5438d4b8
Z
368This is a list of some significant unfixed bugs, which are regressions
369from either 5.XXX.XXX or 5.XXX.XXX.
e22e289d 370
5438d4b8 371[ List each fix as a =item entry ]
e22e289d 372
5438d4b8 373=over 4
e22e289d 374
b908e258
Z
375=item *
376
5438d4b8 377XXX
4ec40670 378
5438d4b8 379=back
4ec40670 380
5438d4b8 381=head1 Obituary
b908e258 382
5438d4b8
Z
383XXX If any significant core contributor has died, we've added a short obituary
384here.
42a91c97 385
44691e6f
AB
386=head1 Acknowledgements
387
f1c1ecab 388XXX Generate this with:
5438d4b8
Z
389
390 perl Porting/acknowledgements.pl v5.15.1..HEAD
29cf780c 391
44691e6f
AB
392=head1 Reporting Bugs
393
394If you find what you think is a bug, you might check the articles
34dc2ec0 395recently posted to the comp.lang.perl.misc newsgroup and the perl
44691e6f
AB
396bug database at http://rt.perl.org/perlbug/ . There may also be
397information at http://www.perl.org/ , the Perl Home Page.
398
399If you believe you have an unreported bug, please run the L<perlbug>
400program included with your release. Be sure to trim your bug down
401to a tiny but sufficient test case. Your bug report, along with the
402output of C<perl -V>, will be sent off to perlbug@perl.org to be
403analysed by the Perl porting team.
404
405If the bug you are reporting has security implications, which make it
406inappropriate to send to a publicly archived mailing list, then please send
34dc2ec0 407it to perl5-security-report@perl.org. This points to a closed subscription
b4707b2a
FC
408unarchived mailing list, which includes
409all the core committers, who will be able
44691e6f
AB
410to help assess the impact of issues, figure out a resolution, and help
411co-ordinate the release of patches to mitigate or fix the problem across all
34dc2ec0
DM
412platforms on which Perl is supported. Please only use this address for
413security issues in the Perl core, not for modules independently
44691e6f
AB
414distributed on CPAN.
415
416=head1 SEE ALSO
417
418The F<Changes> file for an explanation of how to view exhaustive details
419on what changed.
420
421The F<INSTALL> file for how to build Perl.
422
423The F<README> file for general stuff.
424
425The F<Artistic> and F<Copying> files for copyright information.
426
427=cut