This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
perldelta - Documentation updates
[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<perlebcdic>
227
228 =over 4
229
230 =item *
231
232 This document has been significantly updated in the light of recent
233 improvements to EBCDIC support.
234
235 =back
236
237 =head3 L<perlhacktips>
238
239 =over 4
240
241 =item *
242
243 Documentation has been added illustrating the perils of assuming the contents of
244 static memory pointed to by the return values of Perl wrappers for C library
245 functions doesn't change.
246
247 =back
248
249 =head3 L<perlvms>
250
251 =over 4
252
253 =item *
254
255 Out-of-date and/or incorrect material has been removed.
256
257 =back
258
259 =head1 Diagnostics
260
261 The following additions or changes have been made to diagnostic output,
262 including warnings and fatal error messages.  For the complete list of
263 diagnostic messages, see L<perldiag>.
264
265 XXX New or changed warnings emitted by the core's C<C> code go here.  Also
266 include any changes in L<perldiag> that reconcile it to the C<C> code.
267
268 =head2 New Diagnostics
269
270 XXX Newly added diagnostic messages go under here, separated into New Errors
271 and New Warnings
272
273 =head3 New Errors
274
275 =over 4
276
277 =item *
278
279 XXX L<message|perldiag/"message">
280
281 =back
282
283 =head3 New Warnings
284
285 =over 4
286
287 =item *
288
289 XXX L<message|perldiag/"message">
290
291 =back
292
293 =head2 Changes to Existing Diagnostics
294
295 XXX Changes (i.e. rewording) of diagnostic messages go here
296
297 =over 4
298
299 =item *
300
301 XXX Describe change here
302
303 =back
304
305 =head1 Utility Changes
306
307 XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here.
308 Most of these are built within the directory F<utils>.
309
310 [ List utility changes as a =head2 entry for each utility and =item
311 entries for each change
312 Use L<XXX> with program names to get proper documentation linking. ]
313
314 =head2 L<XXX>
315
316 =over 4
317
318 =item *
319
320 XXX
321
322 =back
323
324 =head1 Configuration and Compilation
325
326 XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
327 go here.  Any other changes to the Perl build process should be listed here.
328 However, any platform-specific changes should be listed in the
329 L</Platform Support> section, instead.
330
331 [ List changes as a =item entry ].
332
333 =over 4
334
335 =item *
336
337 XXX
338
339 =back
340
341 =head1 Testing
342
343 XXX Any significant changes to the testing of a freshly built perl should be
344 listed here.  Changes which create B<new> files in F<t/> go here as do any
345 large changes to the testing harness (e.g. when parallel testing was added).
346 Changes to existing files in F<t/> aren't worth summarizing, although the bugs
347 that they represent may be covered elsewhere.
348
349 [ List each test improvement as a =item entry ]
350
351 =over 4
352
353 =item *
354
355 XXX
356
357 =back
358
359 =head1 Platform Support
360
361 XXX Any changes to platform support should be listed in the sections below.
362
363 [ Within the sections, list each platform as a =item entry with specific
364 changes as paragraphs below it. ]
365
366 =head2 New Platforms
367
368 XXX List any platforms that this version of perl compiles on, that previous
369 versions did not.  These will either be enabled by new files in the F<hints/>
370 directories, or new subdirectories and F<README> files at the top level of the
371 source tree.
372
373 =over 4
374
375 =item XXX-some-platform
376
377 XXX
378
379 =back
380
381 =head2 Discontinued Platforms
382
383 XXX List any platforms that this version of perl no longer compiles on.
384
385 =over 4
386
387 =item XXX-some-platform
388
389 XXX
390
391 =back
392
393 =head2 Platform-Specific Notes
394
395 XXX List any changes for specific platforms.  This could include configuration
396 and compilation changes or changes in portability/compatibility.  However,
397 changes within modules for platforms should generally be listed in the
398 L</Modules and Pragmata> section.
399
400 =over 4
401
402 =item Win32
403
404 F<miniperl.exe> is now built with C<-fno-strict-aliasing>, allowing
405 64-bit builds to complete on GCC 4.8. [perl #123976]
406
407 C<test-prep> again depends on C<test-prep-gcc> for GCC builds. [perl
408 #124221]
409
410 =back
411
412 =head1 Internal Changes
413
414 =over 4
415
416 =item *
417
418 5.21.2 introduced a new build option, C<-DPERL_OP_PARENT>, which causes
419 the last C<op_sibling> pointer to refer back to the parent rather than
420 being C<NULL>, and where instead a new flag indicates the end of the
421 chain. In this release, the new implementation has been revised; in
422 particular:
423
424 =over 4
425
426 =item *
427
428 On C<PERL_OP_PARENT> builds, the C<op_sibling> field has been renamed
429 C<op_sibparent> to reflect its new dual purpose. Since the intention is that
430 this field should primarily be accessed via macros, this change should be
431 transparent for code written to work under C<PERL_OP_PARENT>.
432
433 =item *
434
435 The newly-introduced C<op_lastsib> flag bit has been renamed C<op_moresib>
436 and its logic inverted; i.e. it is initialised to zero in a new op, and is
437 changed to 1 when an op gains a sibling.
438
439 =item *
440
441 The function C<Perl_op_parent> is now only available on C<PERL_OP_PARENT>
442 builds. Using it on a plain build will be a compile-timer error.
443
444 =item *
445
446 Three new macros, C<OpMORESIB_set>, C<OpLASTSIB_set>, C<OpMAYBESIB_set>
447 have been added, which are intended to be be a low-level portable way to
448 set C<op_sibling> / C<op_sibparent> while also updating C<op_moresib>.
449 The first sets the sibling pointer to a new sibling, the second makes the
450 op the last sibling, and the third conditionally does the first or second
451 action. The C<op_sibling_splice()> function is retained as a higher-level
452 interface that can also maintain consistency in the parent at the same time
453 (e.g. by updating C<op_first> and C<op_last> where appropriate).
454
455 =item *
456
457 The macro C<OpSIBLING_set>, added in 5.21.2, has been removed. It didn't
458 manipulate C<op_moresib> and has been superseded by C<OpMORESIB_set> et
459 al.
460
461 =item *
462
463 The C<op_sibling_splice> function now accepts a null C<parent> argument
464 where the splicing doesn't affect the first or last ops in the sibling
465 chain, and thus where the parent doesn't need to be updated accordingly.
466
467 =back
468
469
470 =back
471
472 =head1 Selected Bug Fixes
473
474 XXX Important bug fixes in the core language are summarized here.  Bug fixes in
475 files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>.
476
477 [ List each fix as a =item entry ]
478
479 =over 4
480
481 =item *
482
483 C<pack("D", $x)> and C<pack("F", $x)> now zero the padding on x86 long
484 double builds.  GCC 4.8 and later, under some build options, would
485 either overwrite the zero-initialized padding, or bypass the
486 initialized buffer entirely.  This caused F<op/pack.t> to fail.  [perl
487 #123971]
488
489 =item *
490
491 Extending an array cloned from a parent thread could result in
492 "Modification of a read-only value attempted" errors when attempting
493 to modify the new elements. [perl #124127]
494
495 =back
496
497 =head1 Known Problems
498
499 XXX Descriptions of platform agnostic bugs we know we can't fix go here.  Any
500 tests that had to be C<TODO>ed for the release would be noted here.  Unfixed
501 platform specific bugs also go here.
502
503 [ List each fix as a =item entry ]
504
505 =over 4
506
507 =item *
508
509 XXX
510
511 =back
512
513 =head1 Errata From Previous Releases
514
515 =over 4
516
517 =item *
518
519 XXX Add anything here that we forgot to add, or were mistaken about, in
520 the perldelta of a previous release.
521
522 =back
523
524 =head1 Obituary
525
526 XXX If any significant core contributor has died, we've added a short obituary
527 here.
528
529 =head1 Acknowledgements
530
531 XXX Generate this with:
532
533   perl Porting/acknowledgements.pl v5.21.10..HEAD
534
535 =head1 Reporting Bugs
536
537 If you find what you think is a bug, you might check the articles recently
538 posted to the comp.lang.perl.misc newsgroup and the perl bug database at
539 https://rt.perl.org/ .  There may also be information at
540 http://www.perl.org/ , the Perl Home Page.
541
542 If you believe you have an unreported bug, please run the L<perlbug> program
543 included with your release.  Be sure to trim your bug down to a tiny but
544 sufficient test case.  Your bug report, along with the output of C<perl -V>,
545 will be sent off to perlbug@perl.org to be analysed by the Perl porting team.
546
547 If the bug you are reporting has security implications, which make it
548 inappropriate to send to a publicly archived mailing list, then please send it
549 to perl5-security-report@perl.org.  This points to a closed subscription
550 unarchived mailing list, which includes all the core committers, who will be
551 able to help assess the impact of issues, figure out a resolution, and help
552 co-ordinate the release of patches to mitigate or fix the problem across all
553 platforms on which Perl is supported.  Please only use this address for
554 security issues in the Perl core, not for modules independently distributed on
555 CPAN.
556
557 =head1 SEE ALSO
558
559 The F<Changes> file for an explanation of how to view exhaustive details on
560 what changed.
561
562 The F<INSTALL> file for how to build Perl.
563
564 The F<README> file for general stuff.
565
566 The F<Artistic> and F<Copying> files for copyright information.
567
568 =cut