This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
7156497ac4d6ea0b88597f05dcc9fe2c899f77a7
[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.21.11
9
10 =head1 DESCRIPTION
11
12 This document describes differences between the 5.21.10 release and the 5.21.11
13 release.
14
15 If you are upgrading from an earlier release such as 5.21.9, first read
16 L<perl52110delta>, which describes differences between 5.21.9 and 5.21.10.
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 =head1 Security
31
32 XXX Any security-related notices go here.  In particular, any security
33 vulnerabilities closed should be noted here rather than in the
34 L</Selected Bug Fixes> section.
35
36 [ List each security issue as a =head2 entry ]
37
38 =head1 Incompatible Changes
39
40 XXX For a release on a stable branch, this section aspires to be:
41
42     There are no changes intentionally incompatible with 5.XXX.XXX
43     If any exist, they are bugs, and we request that you submit a
44     report.  See L</Reporting Bugs> below.
45
46 [ List each incompatible change as a =head2 entry ]
47
48 =head1 Deprecations
49
50 XXX Any deprecated features, syntax, modules etc. should be listed here.
51
52 =head2 Making all warnings fatal is discouraged
53
54 The documentation for L<fatal warnings|warnings/Fatal Warnings> notes
55 that C<< use warnings FATAL => 'all' >> is discouraged
56 and provides stronger language about the risks of fatal warnings
57 in general.
58
59 =head2 Module removals
60
61 XXX Remove this section if inapplicable.
62
63 The following modules will be removed from the core distribution in a
64 future release, and will at that time need to be installed from CPAN.
65 Distributions on CPAN which require these modules will need to list them as
66 prerequisites.
67
68 The core versions of these modules will now issue C<"deprecated">-category
69 warnings to alert you to this fact.  To silence these deprecation warnings,
70 install the modules in question from CPAN.
71
72 Note that these are (with rare exceptions) fine modules that you are encouraged
73 to continue to use.  Their disinclusion from core primarily hinges on their
74 necessity to bootstrapping a fully functional, CPAN-capable Perl installation,
75 not usually on concerns over their design.
76
77 =over
78
79 =item XXX
80
81 XXX Note that deprecated modules should be listed here even if they are listed
82 as an updated module in the L</Modules and Pragmata> section.
83
84 =back
85
86 [ List each other deprecation as a =head2 entry ]
87
88 =head1 Performance Enhancements
89
90 XXX Changes which enhance performance without changing behaviour go here.
91 There may well be none in a stable release.
92
93 [ List each enhancement as a =item entry ]
94
95 =over 4
96
97 =item *
98
99 XXX
100
101 =back
102
103 =head1 Modules and Pragmata
104
105 XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
106 go here.  If Module::CoreList is updated, generate an initial draft of the
107 following sections using F<Porting/corelist-perldelta.pl>.  A paragraph summary
108 for important changes should then be added by hand.  In an ideal world,
109 dual-life modules would have a F<Changes> file that could be cribbed.
110
111 [ Within each section, list entries as a =item entry ]
112
113 =head2 New Modules and Pragmata
114
115 =over 4
116
117 =item *
118
119 XXX
120
121 =back
122
123 =head2 Updated Modules and Pragmata
124
125 =over 4
126
127 =item *
128
129 L<attributes> has been upgraded from version 0.26 to 0.27.
130
131 =item *
132
133 L<B> has been upgraded from version 1.57 to 1.58.
134
135 =item *
136
137 L<B::Deparse> has been upgraded from version 1.34 to 1.35.
138
139 =item *
140
141 L<Config::Perl::V> has been upgraded from version 0.23 to 0.24.
142
143 =item *
144
145 L<Cwd> has been upgraded from version 3.55 to 3.56.
146
147 =item *
148
149 L<ExtUtils::Miniperl> has been upgraded from version 1.04 to 1.05.
150
151 =item *
152
153 L<ExtUtils::ParseXS> has been upgraded from version 3.27 to 3.28.
154
155 =item *
156
157 L<ExtUtils::Typemaps> has been upgraded from version 3.25 to 3.28.
158
159 =item *
160
161 L<File::Spec> has been upgraded from version 3.55 to 3.56.
162
163 =item *
164
165 L<if> has been upgraded from version 0.0603 to 0.0604.
166
167 =item *
168
169 L<IO::Socket::IP> has been upgraded from version 0.36 to 0.37.
170
171 =item *
172
173 L<Module::CoreList> has been upgraded from version 5.20150320 to 5.20150420.
174
175 Updated to cover the latest releases of Perl.
176
177 =item *
178
179 L<perl5db.pl> has been upgraded from 1.48 to 1.49.
180
181 The debugger would cause an assertion failure.  [perl #124127]
182
183 =item *
184
185 L<PerlIO::mmap> has been upgraded from version 0.013 to 0.014.
186
187 =item *
188
189 L<utf8> has been upgraded from version 1.15 to 1.16.
190
191 =item *
192
193 L<warnings> has been upgraded from version 1.31 to 1.32.
194
195 =back
196
197 =head2 Removed Modules and Pragmata
198
199 =over 4
200
201 =item *
202
203 XXX
204
205 =back
206
207 =head1 Documentation
208
209 XXX Changes to files in F<pod/> go here.  Consider grouping entries by
210 file and be sure to link to the appropriate page, e.g. L<perlfunc>.
211
212 =head2 New Documentation
213
214 XXX Changes which create B<new> files in F<pod/> go here.
215
216 =head3 L<XXX>
217
218 XXX Description of the purpose of the new file here
219
220 =head2 Changes to Existing Documentation
221
222 XXX Changes which significantly change existing files in F<pod/> go here.
223 However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
224 section.
225
226 =head3 L<XXX>
227
228 =over 4
229
230 =item *
231
232 XXX Description of the change here
233
234 =back
235
236 =head1 Diagnostics
237
238 The following additions or changes have been made to diagnostic output,
239 including warnings and fatal error messages.  For the complete list of
240 diagnostic messages, see L<perldiag>.
241
242 XXX New or changed warnings emitted by the core's C<C> code go here.  Also
243 include any changes in L<perldiag> that reconcile it to the C<C> code.
244
245 =head2 New Diagnostics
246
247 XXX Newly added diagnostic messages go under here, separated into New Errors
248 and New Warnings
249
250 =head3 New Errors
251
252 =over 4
253
254 =item *
255
256 XXX L<message|perldiag/"message">
257
258 =back
259
260 =head3 New Warnings
261
262 =over 4
263
264 =item *
265
266 XXX L<message|perldiag/"message">
267
268 =back
269
270 =head2 Changes to Existing Diagnostics
271
272 XXX Changes (i.e. rewording) of diagnostic messages go here
273
274 =over 4
275
276 =item *
277
278 XXX Describe change here
279
280 =back
281
282 =head1 Utility Changes
283
284 XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here.
285 Most of these are built within the directory F<utils>.
286
287 [ List utility changes as a =head2 entry for each utility and =item
288 entries for each change
289 Use L<XXX> with program names to get proper documentation linking. ]
290
291 =head2 L<XXX>
292
293 =over 4
294
295 =item *
296
297 XXX
298
299 =back
300
301 =head1 Configuration and Compilation
302
303 XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
304 go here.  Any other changes to the Perl build process should be listed here.
305 However, any platform-specific changes should be listed in the
306 L</Platform Support> section, instead.
307
308 [ List changes as a =item entry ].
309
310 =over 4
311
312 =item *
313
314 XXX
315
316 =back
317
318 =head1 Testing
319
320 XXX Any significant changes to the testing of a freshly built perl should be
321 listed here.  Changes which create B<new> files in F<t/> go here as do any
322 large changes to the testing harness (e.g. when parallel testing was added).
323 Changes to existing files in F<t/> aren't worth summarizing, although the bugs
324 that they represent may be covered elsewhere.
325
326 [ List each test improvement as a =item entry ]
327
328 =over 4
329
330 =item *
331
332 XXX
333
334 =back
335
336 =head1 Platform Support
337
338 XXX Any changes to platform support should be listed in the sections below.
339
340 [ Within the sections, list each platform as a =item entry with specific
341 changes as paragraphs below it. ]
342
343 =head2 New Platforms
344
345 XXX List any platforms that this version of perl compiles on, that previous
346 versions did not.  These will either be enabled by new files in the F<hints/>
347 directories, or new subdirectories and F<README> files at the top level of the
348 source tree.
349
350 =over 4
351
352 =item XXX-some-platform
353
354 XXX
355
356 =back
357
358 =head2 Discontinued Platforms
359
360 XXX List any platforms that this version of perl no longer compiles on.
361
362 =over 4
363
364 =item XXX-some-platform
365
366 XXX
367
368 =back
369
370 =head2 Platform-Specific Notes
371
372 XXX List any changes for specific platforms.  This could include configuration
373 and compilation changes or changes in portability/compatibility.  However,
374 changes within modules for platforms should generally be listed in the
375 L</Modules and Pragmata> section.
376
377 =over 4
378
379 =item Win32
380
381 F<miniperl.exe> is now built with C<-fno-strict-aliasing>, allowing
382 64-bit builds to complete on GCC 4.8. [perl #123976]
383
384 C<test-prep> again depends on C<test-prep-gcc> for GCC builds. [perl
385 #124221]
386
387 =back
388
389 =head1 Internal Changes
390
391 =over 4
392
393 =item *
394
395 5.21.2 introduced a new build option, C<-DPERL_OP_PARENT>, which causes
396 the last C<op_sibling> pointer to refer back to the parent rather than
397 being C<NULL>, and where instead a new flag indicates the end of the
398 chain. In this release, the new implementation has been revised; in
399 particular:
400
401 =over 4
402
403 =item *
404
405 On C<PERL_OP_PARENT> builds, the C<op_sibling> field has been renamed
406 C<op_sibparent> to reflect its new dual purpose. Since the intention is that
407 this field should primarily be accessed via macros, this change should be
408 transparent for code written to work under C<PERL_OP_PARENT>.
409
410 =item *
411
412 The newly-introduced C<op_lastsib> flag bit has been renamed C<op_moresib>
413 and its logic inverted; i.e. it is initialised to zero in a new op, and is
414 changed to 1 when an op gains a sibling.
415
416 =item *
417
418 The function C<Perl_op_parent> is now only available on C<PERL_OP_PARENT>
419 builds. Using it on a plain build will be a compile-timer error.
420
421 =item *
422
423 Three new macros, C<OpMORESIB_set>, C<OpLASTSIB_set>, C<OpMAYBESIB_set>
424 have been added, which are intended to be be a low-level portable way to
425 set C<op_sibling> / C<op_sibparent> while also updating C<op_moresib>.
426 The first sets the sibling pointer to a new sibling, the second makes the
427 op the last sibling, and the third conditionally does the first or second
428 action. The C<op_sibling_splice()> function is retained as a higher-level
429 interface that can also maintain consistency in the parent at the same time
430 (e.g. by updating C<op_first> and C<op_last> where appropriate).
431
432 =item *
433
434 The macro C<OpSIBLING_set>, added in 5.21.2, has been removed. It didn't
435 manipulate C<op_moresib> and has been superseded by C<OpMORESIB_set> et
436 al.
437
438 =item *
439
440 The C<op_sibling_splice> function now accepts a null C<parent> argument
441 where the splicing doesn't affect the first or last ops in the sibling
442 chain, and thus where the parent doesn't need to be updated accordingly.
443
444 =back
445
446
447 =back
448
449 =head1 Selected Bug Fixes
450
451 XXX Important bug fixes in the core language are summarized here.  Bug fixes in
452 files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>.
453
454 [ List each fix as a =item entry ]
455
456 =over 4
457
458 =item *
459
460 C<pack("D", $x)> and C<pack("F", $x)> now zero the padding on x86 long
461 double builds.  GCC 4.8 and later, under some build options, would
462 either overwrite the zero-initialized padding, or bypass the
463 initialized buffer entirely.  This caused F<op/pack.t> to fail.  [perl
464 #123971]
465
466 =item *
467
468 Extending an array cloned from a parent thread could result in
469 "Modification of a read-only value attempted" errors when attempting
470 to modify the new elements. [perl #124127]
471
472 =back
473
474 =head1 Known Problems
475
476 XXX Descriptions of platform agnostic bugs we know we can't fix go here.  Any
477 tests that had to be C<TODO>ed for the release would be noted here.  Unfixed
478 platform specific bugs also go here.
479
480 [ List each fix as a =item entry ]
481
482 =over 4
483
484 =item *
485
486 XXX
487
488 =back
489
490 =head1 Errata From Previous Releases
491
492 =over 4
493
494 =item *
495
496 XXX Add anything here that we forgot to add, or were mistaken about, in
497 the perldelta of a previous release.
498
499 =back
500
501 =head1 Obituary
502
503 XXX If any significant core contributor has died, we've added a short obituary
504 here.
505
506 =head1 Acknowledgements
507
508 XXX Generate this with:
509
510   perl Porting/acknowledgements.pl v5.21.10..HEAD
511
512 =head1 Reporting Bugs
513
514 If you find what you think is a bug, you might check the articles recently
515 posted to the comp.lang.perl.misc newsgroup and the perl bug database at
516 https://rt.perl.org/ .  There may also be information at
517 http://www.perl.org/ , the Perl Home Page.
518
519 If you believe you have an unreported bug, please run the L<perlbug> program
520 included with your release.  Be sure to trim your bug down to a tiny but
521 sufficient test case.  Your bug report, along with the output of C<perl -V>,
522 will be sent off to perlbug@perl.org to be analysed by the Perl porting team.
523
524 If the bug you are reporting has security implications, which make it
525 inappropriate to send to a publicly archived mailing list, then please send it
526 to perl5-security-report@perl.org.  This points to a closed subscription
527 unarchived mailing list, which includes all the core committers, who will be
528 able to help assess the impact of issues, figure out a resolution, and help
529 co-ordinate the release of patches to mitigate or fix the problem across all
530 platforms on which Perl is supported.  Please only use this address for
531 security issues in the Perl core, not for modules independently distributed on
532 CPAN.
533
534 =head1 SEE ALSO
535
536 The F<Changes> file for an explanation of how to view exhaustive details on
537 what changed.
538
539 The F<INSTALL> file for how to build Perl.
540
541 The F<README> file for general stuff.
542
543 The F<Artistic> and F<Copying> files for copyright information.
544
545 =cut