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