This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
perldelta for mutable inlining & folding
[perl5.git] / pod / perldelta.pod
1 =encoding utf8
2
3 =head1 NAME
4
5 [ this is a template for a new perldelta file.  Any text flagged as XXX needs
6 to be processed before release. ]
7
8 perldelta - what is new for perl v5.19.3
9
10 =head1 DESCRIPTION
11
12 This document describes differences between the 5.19.2 release and the 5.19.3
13 release.
14
15 If you are upgrading from an earlier release such as 5.19.1, first read
16 L<perl5192delta>, which describes differences between 5.19.1 and 5.19.2.
17
18 =head1 Notice
19
20 XXX Any important notices here
21
22 =head1 Core Enhancements
23
24 XXX New core language features go here.  Summarize user-visible core language
25 enhancements.  Particularly prominent performance optimisations could go
26 here, but most should go in the L</Performance Enhancements> section.
27
28 [ List each enhancement as a =head2 entry ]
29
30 =head2 B<-F> now implies B<-a> and B<-a> implies B<-n>
31
32 Previously B<-F> without B<-a> was a no-op, and B<-a> without B<-n> or
33 B<-p> was a no-op, with this change, if you supply B<-F> then both
34 B<-a> and B<-n> are implied and if you supply B<-a> then B<-n> is implied.
35
36 You can still use B<-p> for its extra behaviour. [perl #116190]
37
38 =head1 Security
39
40 XXX Any security-related notices go here.  In particular, any security
41 vulnerabilities closed should be noted here rather than in the
42 L</Selected Bug Fixes> section.
43
44 [ List each security issue as a =head2 entry ]
45
46 =head1 Incompatible Changes
47
48 XXX For a release on a stable branch, this section aspires to be:
49
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.
53
54 [ List each incompatible change as a =head2 entry ]
55
56 =head1 Deprecations
57
58 XXX Any deprecated features, syntax, modules etc. should be listed here.
59
60 =head2 Module removals
61
62 XXX Remove this section if inapplicable.
63
64 The following modules will be removed from the core distribution in a
65 future release, and will at that time need to be installed from CPAN.
66 Distributions on CPAN which require these modules will need to list them as
67 prerequisites.
68
69 The core versions of these modules will now issue C<"deprecated">-category
70 warnings to alert you to this fact.  To silence these deprecation warnings,
71 install the modules in question from CPAN.
72
73 Note that these are (with rare exceptions) fine modules that you are encouraged
74 to continue to use.  Their disinclusion from core primarily hinges on their
75 necessity to bootstrapping a fully functional, CPAN-capable Perl installation,
76 not usually on concerns over their design.
77
78 =over
79
80 XXX Note that deprecated modules should be listed here even if they are listed
81 as an updated module in the L</Modules and Pragmata> section.
82
83 =back
84
85 [ List each other deprecation as a =head2 entry ]
86
87 =head1 Performance Enhancements
88
89 XXX Changes which enhance performance without changing behaviour go here.
90 There may well be none in a stable release.
91
92 [ List each enhancement as a =item entry ]
93
94 =over 4
95
96 =item *
97
98 XXX
99
100 =back
101
102 =head1 Modules and Pragmata
103
104 XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
105 go here.  If Module::CoreList is updated, generate an initial draft of the
106 following sections using F<Porting/corelist-perldelta.pl>, which prints stub
107 entries to STDOUT.  Results can be pasted in place of the '=head2' entries
108 below.  A paragraph summary for important changes should then be added by hand.
109 In an ideal world, dual-life modules would have a F<Changes> file that could be
110 cribbed.
111
112 [ Within each section, list entries as a =item entry ]
113
114 =head2 New Modules and Pragmata
115
116 =over 4
117
118 =item *
119
120 XXX
121
122 =back
123
124 =head2 Updated Modules and Pragmata
125
126 =over 4
127
128 =item *
129
130 L<B> has been upgraded from version 1.44 to 1.45.
131
132 Calling the C<GV> method on C<B::CV> objects created from a lexical
133 sub would return nonsense, possibly crashing perl. C<GV> now returns
134 C<undef> for lexical subs. [perl #118525]
135
136 Added the C<NAME_HEK> method to return the name of a lexical sub.
137
138 =item *
139
140 L<bignum> has been upgraded from version 0.35 to 0.36.
141
142 L<bigrat> wasn't correctly updating an internal variable when C<use>d
143 with a C<lib> option.
144
145 L<Carp> has been upgraded from 1.30 to 1.31
146
147 L<Carp> now handles objects with string overloads. It also allows objects
148 to specify how they appear in the stack dump with a C<CARP_TRACE> method,
149 and also allows the user to specify their own formatter for objects without
150 C<CARP_TRACE> as well as other references. [perl #92446]
151
152 =item *
153
154 L<Compress::Raw::Bzip2> has been upgraded from 2.061 to 2.062.
155
156 =item *
157
158 L<Compress::Raw::Zlib> has been upgraded from 2.061 to 2.062.
159
160 =item *
161
162 L<Config::Perl::V> has been upgraded from version 0.18 to 0.19.
163
164 =item *
165
166 L<Data::Dumper> has been upgraded from version 2.147 to 2.148.
167
168 The compatbility of the XS implementation with the pure perl version
169 under C<Useqq> has been improved. [perl #118933]
170
171 =item *
172
173 L<Devel::Peek> has been upgraded from version 1.12 to 1.13.
174
175 The C<SvREFCNT_inc()> and C<SvREFCNT_dec()> functions have been
176 removed and C<SvREFCNT()> will now work on non-scalars. [perl #117793]
177
178 =item *
179
180 L<Exporter> has been upgraded from version 5.68 to 5.69.
181
182 L<Exporter> would ignore custom C<$SIG{__WARN__}> handlers in
183 C<Exporter::Heavy>. [perl #39739]
184
185 =item *
186
187 The IO-Compress module collection has been upgraded from 2.061 to 2.062.
188
189 =item *
190
191 L<IPC::Cmd> has been upgraded from version 0.82 to 0.84.
192
193 C<run_forked> has various fixes/improvements, L<Socket> is only used where
194 needed and a regression introduced in 0.78 has been fixed.
195
196 =item *
197
198 The libnet module collection has been upgraded from version 1.22 to 1.23.
199
200 =item *
201
202 L<List::Util> has been upgraded from version 1.27 to 1.30
203
204 L<List::Util> now includes C<pairgrep>, C<pairmap>, C<pairs>, C<pairkeys>,
205 C<pairvalues> and C<pairfirst> functions that operate on even-sized lists of
206 pairs.
207
208 =item *
209
210 L<parent> has been upgraded from version 0.225 to 0.226.
211
212 =item *
213
214 L<Socket> has been upgraded from version 2.010 to 2.011.
215
216 Handle FreeBSD (or other platforms) returning shorter AF_UNIX sockaddr
217 structures due to embedded sun_len. [cpan #86613]
218
219 =item *
220
221 L<Storable> has been upgraded from version 2.45 to 2.46.
222
223 Avoid creating temporary objects for STORABLE_attach when they aren't
224 required. [perl #118907]
225
226 =item *
227
228 L<Time::Piece> has been upgraded from version 1.21 to 1.22.
229
230 =back
231
232 =head2 Removed Modules and Pragmata
233
234 =over 4
235
236 =item *
237
238 XXX
239
240 =back
241
242 =head1 Documentation
243
244 XXX Changes to files in F<pod/> go here.  Consider grouping entries by
245 file and be sure to link to the appropriate page, e.g. L<perlfunc>.
246
247 =head2 New Documentation
248
249 XXX Changes which create B<new> files in F<pod/> go here.
250
251 =head3 L<XXX>
252
253 XXX Description of the purpose of the new file here
254
255 =head2 Changes to Existing Documentation
256
257 XXX Changes which significantly change existing files in F<pod/> go here.
258 However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
259 section.
260
261 =head3 L<perlopentut>
262
263 =over 4
264
265 =item *
266
267 The C<open> tutorial has been completely rewriten by Tom Christiansen, and now
268 focuses on covering only the basics, rather than providing a comprehensive
269 reference to all things openable.  This rewrite came as the result of a
270 vigorous discussion on perl5-porters kicked off by a set of improvements
271 written by Alexander Hartmaier to the existing C<perlopentut>.  A "more than
272 you ever wanted to know about C<open>" document may follow in subsequent
273 versions of perl.
274
275 =back
276
277 =head1 Diagnostics
278
279 The following additions or changes have been made to diagnostic output,
280 including warnings and fatal error messages.  For the complete list of
281 diagnostic messages, see L<perldiag>.
282
283 XXX New or changed warnings emitted by the core's C<C> code go here.  Also
284 include any changes in L<perldiag> that reconcile it to the C<C> code.
285
286 =head2 New Diagnostics
287
288 XXX Newly added diagnostic messages go under here, separated into New Errors
289 and New Warnings
290
291 =head3 New Errors
292
293 =over 4
294
295 =item *
296
297 XXX L<message|perldiag/"message">
298
299 =back
300
301 =head3 New Warnings
302
303 =over 4
304
305 =item *
306
307 XXX L<message|perldiag/"message">
308
309 =back
310
311 =head2 Changes to Existing Diagnostics
312
313 XXX Changes (i.e. rewording) of diagnostic messages go here
314
315 =over 4
316
317 =item *
318
319 XXX Describe change here
320
321 =back
322
323 =head1 Utility Changes
324
325 XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here.
326 Most of these are built within the directories F<utils> and F<x2p>.
327
328 [ List utility changes as a =head3 entry for each utility and =item
329 entries for each change
330 Use L<XXX> with program names to get proper documentation linking. ]
331
332 =head3 L<XXX>
333
334 =over 4
335
336 =item *
337
338 XXX
339
340 =back
341
342 =head1 Configuration and Compilation
343
344 XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
345 go here.  Any other changes to the Perl build process should be listed here.
346 However, any platform-specific changes should be listed in the
347 L</Platform Support> section, instead.
348
349 [ List changes as a =item entry ].
350
351 =over 4
352
353 =item *
354
355 XXX
356
357 =back
358
359 =head1 Testing
360
361 XXX Any significant changes to the testing of a freshly built perl should be
362 listed here.  Changes which create B<new> files in F<t/> go here as do any
363 large changes to the testing harness (e.g. when parallel testing was added).
364 Changes to existing files in F<t/> aren't worth summarizing, although the bugs
365 that they represent may be covered elsewhere.
366
367 [ List each test improvement as a =item entry ]
368
369 =over 4
370
371 =item *
372
373 XXX
374
375 =back
376
377 =head1 Platform Support
378
379 XXX Any changes to platform support should be listed in the sections below.
380
381 [ Within the sections, list each platform as a =item entry with specific
382 changes as paragraphs below it. ]
383
384 =head2 New Platforms
385
386 XXX List any platforms that this version of perl compiles on, that previous
387 versions did not.  These will either be enabled by new files in the F<hints/>
388 directories, or new subdirectories and F<README> files at the top level of the
389 source tree.
390
391 =over 4
392
393 =item XXX-some-platform
394
395 XXX
396
397 =back
398
399 =head2 Discontinued Platforms
400
401 XXX List any platforms that this version of perl no longer compiles on.
402
403 =over 4
404
405 =item XXX-some-platform
406
407 XXX
408
409 =back
410
411 =head2 Platform-Specific Notes
412
413 XXX List any changes for specific platforms.  This could include configuration
414 and compilation changes or changes in portability/compatibility.  However,
415 changes within modules for platforms should generally be listed in the
416 L</Modules and Pragmata> section.
417
418 =over 4
419
420 =item XXX-some-platform
421
422 XXX
423
424 =back
425
426 =head1 Internal Changes
427
428 XXX Changes which affect the interface available to C<XS> code go here.  Other
429 significant internal changes for future core maintainers should be noted as
430 well.
431
432 [ List each change as a =item entry ]
433
434 =over 4
435
436 =item *
437
438 C<sv_pos_b2u_flags> has been added to the API.  It is similar to
439 C<sv_pos_b2u>, but supports long strings on 64-bit platforms.
440
441 =back
442
443 =head1 Selected Bug Fixes
444
445 XXX Important bug fixes in the core language are summarized here.  Bug fixes in
446 files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>.
447
448 [ List each fix as a =item entry ]
449
450 =over 4
451
452 =item *
453
454 Autovivifying a subroutine stub via C<\&$glob> started causing crashes in
455 Perl 5.18.0 if the $glob was merely a copy of a real glob, i.e., a scalar
456 that had had a glob assigned to it.  This has been fixed [perl #119051].
457
458 =item *
459
460 On 64-bit platforms C<pos> can now be set to a value higher than 2**31-1
461 [perl #72766].
462
463 =item *
464
465 Perl used to leak an implementation detail when it came to referencing the
466 return values of certain operators.  C<for ($a+$b) { warn \$_; warn \$_ }>
467 used to display two different memory addresses, because the C<\> operator
468 was copying the variable.  Under threaded builds, it would also happen for
469 constants (C<for(1) { ... }>).  This has been fixed [perl #21979, #78194,
470 #89188, #109746, #114838, #115388].
471
472 =item *
473
474 The range operator C<..> was returning the same modifiable scalars with
475 each call, unless it was the only thing in a C<foreach> loop header.  This
476 meant that changes to values within the list returned would be visible the
477 next time the operator was executed [perl #3105].
478
479 =item *
480
481 Constant folding and subroutine inlining no longer cause operations that
482 would normally return new modifiable scalars to return read-only values
483 instead.
484
485 =back
486
487 =head1 Known Problems
488
489 XXX Descriptions of platform agnostic bugs we know we can't fix go here.  Any
490 tests that had to be C<TODO>ed for the release would be noted here.  Unfixed
491 platform specific bugs also go here.
492
493 [ List each fix as a =item entry ]
494
495 =over 4
496
497 =item *
498
499 XXX
500
501 =back
502
503 =head1 Obituary
504
505 XXX If any significant core contributor has died, we've added a short obituary
506 here.
507
508 =head1 Acknowledgements
509
510 XXX Generate this with:
511
512   perl Porting/acknowledgements.pl v5.19.2..HEAD
513
514 =head1 Reporting Bugs
515
516 If you find what you think is a bug, you might check the articles recently
517 posted to the comp.lang.perl.misc newsgroup and the perl bug database at
518 http://rt.perl.org/perlbug/ .  There may also be information at
519 http://www.perl.org/ , the Perl Home Page.
520
521 If you believe you have an unreported bug, please run the L<perlbug> program
522 included with your release.  Be sure to trim your bug down to a tiny but
523 sufficient test case.  Your bug report, along with the output of C<perl -V>,
524 will be sent off to perlbug@perl.org to be analysed by the Perl porting team.
525
526 If the bug you are reporting has security implications, which make it
527 inappropriate to send to a publicly archived mailing list, then please send it
528 to perl5-security-report@perl.org.  This points to a closed subscription
529 unarchived mailing list, which includes all the core committers, who will be
530 able to help assess the impact of issues, figure out a resolution, and help
531 co-ordinate the release of patches to mitigate or fix the problem across all
532 platforms on which Perl is supported.  Please only use this address for
533 security issues in the Perl core, not for modules independently distributed on
534 CPAN.
535
536 =head1 SEE ALSO
537
538 The F<Changes> file for an explanation of how to view exhaustive details on
539 what changed.
540
541 The F<INSTALL> file for how to build Perl.
542
543 The F<README> file for general stuff.
544
545 The F<Artistic> and F<Copying> files for copyright information.
546
547 =cut