This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
perldelta for 486b1e7f0
[perl5.git] / pod / perldelta.pod
CommitLineData
44691e6f
AB
1=encoding utf8
2
3=head1 NAME
4
12dcbffb
AP
5[ this is a template for a new perldelta file. Any text flagged as XXX needs
6to be processed before release. ]
7
8perldelta - what is new for perl v5.19.3
e128ab2c 9
4eabcf70 10=head1 DESCRIPTION
6db9054f 11
12dcbffb 12This document describes differences between the 5.19.2 release and the 5.19.3
e08634c5 13release.
6db9054f 14
12dcbffb
AP
15If you are upgrading from an earlier release such as 5.19.1, first read
16L<perl5192delta>, which describes differences between 5.19.1 and 5.19.2.
42bff0d9 17
12dcbffb 18=head1 Notice
42bff0d9 19
12dcbffb 20XXX Any important notices here
42bff0d9 21
12dcbffb 22=head1 Core Enhancements
c0ca71c9 23
12dcbffb
AP
24XXX New core language features go here. Summarize user-visible core language
25enhancements. Particularly prominent performance optimisations could go
26here, but most should go in the L</Performance Enhancements> section.
c0ca71c9 27
12dcbffb 28[ List each enhancement as a =head2 entry ]
c0ca71c9 29
5bb43e77
TC
30=head2 B<-F> now implies B<-a> and B<-a> implies B<-n>
31
32Previously B<-F> without B<-a> was a no-op, and B<-a> without B<-n> or
33B<-p> was a no-op, with this change, if you supply B<-F> then both
34B<-a> and B<-n> are implied and if you supply B<-a> then B<-n> is implied.
35
36You can still use B<-p> for its extra behaviour. [perl #116190]
37
12dcbffb 38=head1 Security
c0ca71c9 39
12dcbffb
AP
40XXX Any security-related notices go here. In particular, any security
41vulnerabilities closed should be noted here rather than in the
42L</Selected Bug Fixes> section.
c0ca71c9 43
12dcbffb 44[ List each security issue as a =head2 entry ]
c0ca71c9 45
12dcbffb 46=head1 Incompatible Changes
c0ca71c9 47
12dcbffb 48XXX For a release on a stable branch, this section aspires to be:
c0ca71c9 49
12dcbffb
AP
50 There are no changes intentionally incompatible with 5.XXX.XXX
51 If any exist, they are bugs, and we request that you submit a
52 report. See L</Reporting Bugs> below.
c0ca71c9 53
12dcbffb 54[ List each incompatible change as a =head2 entry ]
c0ca71c9 55
12dcbffb 56=head1 Deprecations
c0ca71c9 57
12dcbffb 58XXX Any deprecated features, syntax, modules etc. should be listed here.
c0ca71c9 59
12dcbffb 60=head2 Module removals
c0ca71c9 61
12dcbffb 62XXX Remove this section if inapplicable.
c0ca71c9 63
12dcbffb
AP
64The following modules will be removed from the core distribution in a
65future release, and will at that time need to be installed from CPAN.
66Distributions on CPAN which require these modules will need to list them as
67prerequisites.
c0ca71c9 68
12dcbffb
AP
69The core versions of these modules will now issue C<"deprecated">-category
70warnings to alert you to this fact. To silence these deprecation warnings,
71install the modules in question from CPAN.
c0ca71c9 72
12dcbffb
AP
73Note that these are (with rare exceptions) fine modules that you are encouraged
74to continue to use. Their disinclusion from core primarily hinges on their
75necessity to bootstrapping a fully functional, CPAN-capable Perl installation,
76not usually on concerns over their design.
c0ca71c9 77
12dcbffb 78=over
c0ca71c9 79
12dcbffb
AP
80XXX Note that deprecated modules should be listed here even if they are listed
81as an updated module in the L</Modules and Pragmata> section.
c0ca71c9 82
12dcbffb 83=back
c0ca71c9 84
12dcbffb 85[ List each other deprecation as a =head2 entry ]
c0ca71c9 86
12dcbffb 87=head1 Performance Enhancements
c0ca71c9 88
12dcbffb
AP
89XXX Changes which enhance performance without changing behaviour go here.
90There may well be none in a stable release.
c0ca71c9 91
12dcbffb 92[ List each enhancement as a =item entry ]
c0ca71c9 93
12dcbffb 94=over 4
c0ca71c9
AP
95
96=item *
97
12dcbffb 98XXX
c0ca71c9 99
12dcbffb 100=back
70ba8092 101
12dcbffb 102=head1 Modules and Pragmata
42bff0d9 103
12dcbffb
AP
104XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
105go here. If Module::CoreList is updated, generate an initial draft of the
106following sections using F<Porting/corelist-perldelta.pl>, which prints stub
107entries to STDOUT. Results can be pasted in place of the '=head2' entries
108below. A paragraph summary for important changes should then be added by hand.
109In an ideal world, dual-life modules would have a F<Changes> file that could be
110cribbed.
6e4979f3 111
12dcbffb 112[ Within each section, list entries as a =item entry ]
6e4979f3 113
12dcbffb 114=head2 New Modules and Pragmata
6e4979f3 115
12dcbffb 116=over 4
42bff0d9 117
c0ca71c9 118=item *
42bff0d9 119
12dcbffb 120XXX
42bff0d9 121
12dcbffb 122=back
42bff0d9 123
12dcbffb 124=head2 Updated Modules and Pragmata
42bff0d9 125
12dcbffb 126=over 4
42bff0d9 127
c0ca71c9 128=item *
42bff0d9 129
323602af
TC
130L<B> has been upgraded from version 1.44 to 1.45.
131
132Calling the C<GV> method on C<B::CV> objects created from a lexical
133sub would return nonsense, possibly crashing perl. C<GV> now returns
134C<undef> for lexical subs. [perl #118525]
135
136Added the C<NAME_HEK> method to return the name of a lexical sub.
137
138=item *
139
cffd634c
TC
140L<Data::Dumper> has been upgraded from version 2.147 to 2.148.
141
142The compatbility of the XS implementation with the pure perl version
143under C<Useqq> has been improved. [perl #118933]
42bff0d9 144
2cf99697
TC
145=item *
146
147L<Storable> has been upgraded from version 2.45 to 2.46.
148
149Avoid creating temporary objects for STORABLE_attach when they aren't
150required. [perl #118907]
151
64932d37
TC
152=item *
153
154L<bignum> has been upgraded from version 0.35 to 0.36.
155
156L<bigrat> wasn't correctly updating an internal variable when C<use>d
157with a C<lib> option.
158
6f7e3040
TC
159=item *
160
161L<Exporter> has been upgraded from version 5.68 to 5.69.
162
163L<Exporter> would ignore custom C<$SIG{__WARN__}> handlers in
164C<Exporter::Heavy>. [perl #39739]
165
c0ca71c9 166=back
42bff0d9 167
12dcbffb 168=head2 Removed Modules and Pragmata
dbd04185 169
38663f11 170=over 4
583aa5c2 171
1fdd5e53
KW
172=item *
173
12dcbffb 174XXX
42bff0d9 175
38663f11 176=back
42bff0d9 177
12dcbffb 178=head1 Documentation
989e4501 179
12dcbffb
AP
180XXX Changes to files in F<pod/> go here. Consider grouping entries by
181file and be sure to link to the appropriate page, e.g. L<perlfunc>.
989e4501 182
12dcbffb 183=head2 New Documentation
989e4501 184
12dcbffb 185XXX Changes which create B<new> files in F<pod/> go here.
42bff0d9 186
12dcbffb 187=head3 L<XXX>
42bff0d9 188
12dcbffb 189XXX Description of the purpose of the new file here
42bff0d9 190
12dcbffb 191=head2 Changes to Existing Documentation
42bff0d9 192
12dcbffb
AP
193XXX Changes which significantly change existing files in F<pod/> go here.
194However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
195section.
42bff0d9 196
3031ec7a 197=head3 L<perlopentut>
42bff0d9 198
38663f11 199=over 4
42bff0d9
DG
200
201=item *
202
3031ec7a
RS
203The C<open> tutorial has been completely rewriten by Tom Christiansen, and now
204focuses on covering only the basics, rather than providing a comprehensive
205reference to all things openable. This rewrite came as the result of a
206vigorous discussion on perl5-porters kicked off by a set of improvements
207written by Alexander Hartmaier to the existing C<perlopentut>. A "more than
208you ever wanted to know about C<open>" document may follow in subsequent
209versions of perl.
1fdd5e53 210
583aa5c2
RS
211=back
212
c0ca71c9
AP
213=head1 Diagnostics
214
215The following additions or changes have been made to diagnostic output,
216including warnings and fatal error messages. For the complete list of
217diagnostic messages, see L<perldiag>.
218
12dcbffb
AP
219XXX New or changed warnings emitted by the core's C<C> code go here. Also
220include any changes in L<perldiag> that reconcile it to the C<C> code.
221
c0ca71c9
AP
222=head2 New Diagnostics
223
12dcbffb
AP
224XXX Newly added diagnostic messages go under here, separated into New Errors
225and New Warnings
226
227=head3 New Errors
583aa5c2 228
38663f11 229=over 4
583aa5c2 230
b8a02ff1 231=item *
583aa5c2 232
12dcbffb 233XXX L<message|perldiag/"message">
583aa5c2 234
b8a02ff1 235=back
583aa5c2 236
12dcbffb 237=head3 New Warnings
96d496e4 238
38663f11 239=over 4
b8a02ff1
DG
240
241=item *
242
12dcbffb 243XXX L<message|perldiag/"message">
96d496e4 244
12dcbffb 245=back
1310e590 246
12dcbffb 247=head2 Changes to Existing Diagnostics
e727f86a 248
12dcbffb 249XXX Changes (i.e. rewording) of diagnostic messages go here
e727f86a 250
12dcbffb 251=over 4
e727f86a 252
81ca6d44
FC
253=item *
254
12dcbffb 255XXX Describe change here
81ca6d44 256
96d496e4
RS
257=back
258
12dcbffb 259=head1 Utility Changes
583aa5c2 260
12dcbffb
AP
261XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here.
262Most of these are built within the directories F<utils> and F<x2p>.
71e6aba6 263
12dcbffb
AP
264[ List utility changes as a =head3 entry for each utility and =item
265entries for each change
266Use L<XXX> with program names to get proper documentation linking. ]
d5f315e8 267
12dcbffb 268=head3 L<XXX>
e38fc308
NC
269
270=over 4
271
272=item *
273
12dcbffb 274XXX
e38fc308
NC
275
276=back
277
12dcbffb 278=head1 Configuration and Compilation
2426c394 279
12dcbffb
AP
280XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
281go here. Any other changes to the Perl build process should be listed here.
282However, any platform-specific changes should be listed in the
283L</Platform Support> section, instead.
4724da03 284
12dcbffb 285[ List changes as a =item entry ].
583aa5c2 286
38663f11 287=over 4
a34da6c4 288
12dcbffb 289=item *
a34da6c4 290
12dcbffb 291XXX
a34da6c4 292
583aa5c2
RS
293=back
294
12dcbffb 295=head1 Testing
583aa5c2 296
12dcbffb
AP
297XXX Any significant changes to the testing of a freshly built perl should be
298listed here. Changes which create B<new> files in F<t/> go here as do any
299large changes to the testing harness (e.g. when parallel testing was added).
300Changes to existing files in F<t/> aren't worth summarizing, although the bugs
301that they represent may be covered elsewhere.
1de7c8e6 302
12dcbffb 303[ List each test improvement as a =item entry ]
9c800862 304
12dcbffb 305=over 4
aaf54772 306
b7bbd8b6
FC
307=item *
308
12dcbffb 309XXX
b7bbd8b6 310
583aa5c2
RS
311=back
312
12dcbffb 313=head1 Platform Support
d7bfa554 314
12dcbffb 315XXX Any changes to platform support should be listed in the sections below.
81d3ed5a 316
12dcbffb
AP
317[ Within the sections, list each platform as a =item entry with specific
318changes as paragraphs below it. ]
81d3ed5a 319
12dcbffb 320=head2 New Platforms
0b023496 321
12dcbffb
AP
322XXX List any platforms that this version of perl compiles on, that previous
323versions did not. These will either be enabled by new files in the F<hints/>
324directories, or new subdirectories and F<README> files at the top level of the
325source tree.
0b023496 326
12dcbffb 327=over 4
e11f653d 328
12dcbffb 329=item XXX-some-platform
5e0164b2 330
12dcbffb 331XXX
5e0164b2 332
12dcbffb 333=back
e11f653d 334
12dcbffb 335=head2 Discontinued Platforms
8be8cdec 336
12dcbffb 337XXX List any platforms that this version of perl no longer compiles on.
8be8cdec 338
12dcbffb 339=over 4
07a522a5 340
12dcbffb 341=item XXX-some-platform
07a522a5 342
12dcbffb 343XXX
71b4007c 344
12dcbffb 345=back
71b4007c 346
12dcbffb 347=head2 Platform-Specific Notes
f6b1d2f5 348
12dcbffb
AP
349XXX List any changes for specific platforms. This could include configuration
350and compilation changes or changes in portability/compatibility. However,
351changes within modules for platforms should generally be listed in the
352L</Modules and Pragmata> section.
f6b1d2f5 353
12dcbffb 354=over 4
7e4f209b 355
12dcbffb 356=item XXX-some-platform
7e4f209b 357
12dcbffb 358XXX
558673e6 359
12dcbffb 360=back
558673e6 361
12dcbffb 362=head1 Internal Changes
47a7c93d 363
12dcbffb
AP
364XXX Changes which affect the interface available to C<XS> code go here. Other
365significant internal changes for future core maintainers should be noted as
366well.
47a7c93d 367
12dcbffb 368[ List each change as a =item entry ]
b5a80c26 369
12dcbffb 370=over 4
b5a80c26 371
7f1d4316
FC
372=item *
373
12dcbffb 374XXX
7f1d4316 375
12dcbffb 376=back
02bef66e 377
12dcbffb 378=head1 Selected Bug Fixes
d30fb844 379
12dcbffb
AP
380XXX Important bug fixes in the core language are summarized here. Bug fixes in
381files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>.
d30fb844 382
12dcbffb 383[ List each fix as a =item entry ]
21c01741 384
12dcbffb 385=over 4
21c01741 386
467582e8
FC
387=item *
388
5c24ac0b
FC
389Autovivifying a subroutine stub via C<\&$glob> started causing crashes in
390Perl 5.18.0 if the $glob was merely a copy of a real glob, i.e., a scalar
391that had had a glob assigned to it. This has been fixed [perl #119051].
467582e8 392
38663f11 393=back
d7bfa554 394
38663f11 395=head1 Known Problems
6810f0ad 396
12dcbffb
AP
397XXX Descriptions of platform agnostic bugs we know we can't fix go here. Any
398tests that had to be C<TODO>ed for the release would be noted here. Unfixed
399platform specific bugs also go here.
400
401[ List each fix as a =item entry ]
402
38663f11 403=over 4
14fd9356
FC
404
405=item *
406
12dcbffb 407XXX
0e417e4d 408
38663f11 409=back
583aa5c2 410
12dcbffb
AP
411=head1 Obituary
412
413XXX If any significant core contributor has died, we've added a short obituary
414here.
415
583aa5c2 416=head1 Acknowledgements
a75569c0 417
12dcbffb
AP
418XXX Generate this with:
419
420 perl Porting/acknowledgements.pl v5.19.2..HEAD
f5b73711 421
44691e6f
AB
422=head1 Reporting Bugs
423
e08634c5
SH
424If you find what you think is a bug, you might check the articles recently
425posted to the comp.lang.perl.misc newsgroup and the perl bug database at
426http://rt.perl.org/perlbug/ . There may also be information at
427http://www.perl.org/ , the Perl Home Page.
44691e6f 428
e08634c5
SH
429If you believe you have an unreported bug, please run the L<perlbug> program
430included with your release. Be sure to trim your bug down to a tiny but
431sufficient test case. Your bug report, along with the output of C<perl -V>,
432will be sent off to perlbug@perl.org to be analysed by the Perl porting team.
44691e6f
AB
433
434If the bug you are reporting has security implications, which make it
e08634c5
SH
435inappropriate to send to a publicly archived mailing list, then please send it
436to perl5-security-report@perl.org. This points to a closed subscription
437unarchived mailing list, which includes all the core committers, who will be
438able to help assess the impact of issues, figure out a resolution, and help
f9001595 439co-ordinate the release of patches to mitigate or fix the problem across all
e08634c5
SH
440platforms on which Perl is supported. Please only use this address for
441security issues in the Perl core, not for modules independently distributed on
442CPAN.
44691e6f
AB
443
444=head1 SEE ALSO
445
e08634c5
SH
446The F<Changes> file for an explanation of how to view exhaustive details on
447what changed.
44691e6f
AB
448
449The F<INSTALL> file for how to build Perl.
450
451The F<README> file for general stuff.
452
453The F<Artistic> and F<Copying> files for copyright information.
454
455=cut