This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
perldelta for 54b7cb3
[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.3
9
10 =head1 DESCRIPTION
11
12 This document describes differences between the 5.21.2 release and the 5.21.3
13 release.
14
15 If you are upgrading from an earlier release such as 5.21.1, first read
16 L<perl5212delta>, which describes differences between 5.21.1 and 5.21.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 =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 =head2 S<C<use UNIVERSAL '...'>> is now a fatal error
49
50 Importing functions from C<UNIVERSAL> has been deprecated since v5.12, and
51 is now a fatal error.  S<C<"use UNIVERSAL">> without any arguments is still
52 allowed.
53
54 =head1 Deprecations
55
56 XXX Any deprecated features, syntax, modules etc. should be listed here.
57
58 =head2 Module removals
59
60 XXX Remove this section if inapplicable.
61
62 The following modules will be removed from the core distribution in a
63 future release, and will at that time need to be installed from CPAN.
64 Distributions on CPAN which require these modules will need to list them as
65 prerequisites.
66
67 The core versions of these modules will now issue C<"deprecated">-category
68 warnings to alert you to this fact.  To silence these deprecation warnings,
69 install the modules in question from CPAN.
70
71 Note that these are (with rare exceptions) fine modules that you are encouraged
72 to continue to use.  Their disinclusion from core primarily hinges on their
73 necessity to bootstrapping a fully functional, CPAN-capable Perl installation,
74 not usually on concerns over their design.
75
76 =over
77
78 =item XXX
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>.  A paragraph summary
107 for important changes should then be added by hand.  In an ideal world,
108 dual-life modules would have a F<Changes> file that could be cribbed.
109
110 [ Within each section, list entries as a =item entry ]
111
112 =head2 New Modules and Pragmata
113
114 =over 4
115
116 =item *
117
118 XXX
119
120 =back
121
122 =head2 Updated Modules and Pragmata
123
124 =over 4
125
126 =item *
127
128 L<B::Debug> has been upgraded from version 1.19 to 1.21
129
130 =item *
131
132 L<CPAN::Meta::Requirements> has been upgraded from version 2.125 to 2.126.
133
134 =item *
135
136 L<ExtUtils::Manifest> has been upgraded from version 1.64 to 1.65.
137
138 The MANIFEST is now opened with C<:raw>, to prevent C<CRLF>s leaking in.
139
140 =item *
141
142 L<perl5db.pl> has been upgraded from version 1.45 to 1.46.
143
144 Fixed the scope level handling of the debugger's C<y> command.
145
146 =item *
147
148 L<POSIX> has been upgraded from version 1.41 to 1.42.
149
150 Replaced the thread-unsafe code used to prevent duplicate warning
151 messages for using the isxxx() functions.  [perl #122476]
152
153 =item *
154
155 L<Socket> has been upgraded from version 2.014 to 2.015.
156
157 Test suite updates, particularly useful for Solaris and cygwin, and
158 a slight change to the pattern used for IPv4 address matching.
159
160 =back
161
162 =head2 Removed Modules and Pragmata
163
164 =over 4
165
166 =item *
167
168 XXX
169
170 =back
171
172 =head1 Documentation
173
174 XXX Changes to files in F<pod/> go here.  Consider grouping entries by
175 file and be sure to link to the appropriate page, e.g. L<perlfunc>.
176
177 =head2 New Documentation
178
179 XXX Changes which create B<new> files in F<pod/> go here.
180
181 =head3 L<XXX>
182
183 XXX Description of the purpose of the new file here
184
185 =head2 Changes to Existing Documentation
186
187 XXX Changes which significantly change existing files in F<pod/> go here.
188 However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
189 section.
190
191 =head3 L<XXX>
192
193 =over 4
194
195 =item *
196
197 XXX Description of the change here
198
199 =back
200
201 =head1 Diagnostics
202
203 The following additions or changes have been made to diagnostic output,
204 including warnings and fatal error messages.  For the complete list of
205 diagnostic messages, see L<perldiag>.
206
207 XXX New or changed warnings emitted by the core's C<C> code go here.  Also
208 include any changes in L<perldiag> that reconcile it to the C<C> code.
209
210 =head2 New Diagnostics
211
212 XXX Newly added diagnostic messages go under here, separated into New Errors
213 and New Warnings
214
215 =head3 New Errors
216
217 =over 4
218
219 =item *
220
221 XXX L<message|perldiag/"message">
222
223 =back
224
225 =head3 New Warnings
226
227 =over 4
228
229 =item *
230
231 L<Hexadecimal float: exponent overflow|perldiag/"Hexadecimal float: exponent overflow">
232
233 (W overflow) The hexadecimal floating point has larger exponent
234 than the floating point supports.
235
236 =item *
237
238 L<Hexadecimal float: exponent underflow|perldiag/"Hexadecimal float: exponent underflow">
239
240 (W overflow) The hexadecimal floating point has smaller exponent
241 than the floating point supports.
242
243 =item *
244
245 L<Hexadecimal float: internal error|perldiag/"Hexadecimal float: internal error">
246
247 (F) Something went horribly bad in hexadecimal float handling.
248
249 =item *
250
251 L<Hexadecimal float: mantissa overflow|perldiag/"Hexadecimal float: mantissa overflow">
252
253 (W overflow) The hexadecimal floating point literal had more bits in
254 the mantissa (the part between the 0x and the exponent, also known as
255 the fraction or the significand) than the floating point supports.
256
257 =item *
258
259 L<Hexadecimal float: precision loss|perldiag/"Hexadecimal float: precision loss">
260
261 (W overflow) The hexadecimal floating point had internally more
262 digits than could be output.  This can be caused by unsupported
263 long double formats, or by 64-bit integers not being available
264 (needed to retrieve the digits under some configurations).
265
266 =item *
267
268 L<Hexadecimal float: unsupported long double format|perldiag/"Hexadecimal float: unsupported long double format">
269
270 (F) You have configured Perl to use long doubles but
271 the internals of the long double format are unknown,
272 therefore the hexadecimal float output is impossible.
273
274 =back
275
276 =head2 Changes to Existing Diagnostics
277
278 XXX Changes (i.e. rewording) of diagnostic messages go here
279
280 =over 4
281
282 =item *
283
284 XXX Describe change here
285
286 =back
287
288 =head1 Utility Changes
289
290 XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here.
291 Most of these are built within the directory F<utils>.
292
293 [ List utility changes as a =head2 entry for each utility and =item
294 entries for each change
295 Use L<XXX> with program names to get proper documentation linking. ]
296
297 =head2 L<XXX>
298
299 =over 4
300
301 =item *
302
303 XXX
304
305 =back
306
307 =head1 Configuration and Compilation
308
309 XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
310 go here.  Any other changes to the Perl build process should be listed here.
311 However, any platform-specific changes should be listed in the
312 L</Platform Support> section, instead.
313
314 [ List changes as a =item entry ].
315
316 =over 4
317
318 =item *
319
320 Internal handling of floating point values has been improved.
321
322 =back
323
324 =head1 Testing
325
326 XXX Any significant changes to the testing of a freshly built perl should be
327 listed here.  Changes which create B<new> files in F<t/> go here as do any
328 large changes to the testing harness (e.g. when parallel testing was added).
329 Changes to existing files in F<t/> aren't worth summarizing, although the bugs
330 that they represent may be covered elsewhere.
331
332 [ List each test improvement as a =item entry ]
333
334 =over 4
335
336 =item *
337
338 XXX
339
340 =back
341
342 =head1 Platform Support
343
344 XXX Any changes to platform support should be listed in the sections below.
345
346 [ Within the sections, list each platform as a =item entry with specific
347 changes as paragraphs below it. ]
348
349 =head2 New Platforms
350
351 XXX List any platforms that this version of perl compiles on, that previous
352 versions did not.  These will either be enabled by new files in the F<hints/>
353 directories, or new subdirectories and F<README> files at the top level of the
354 source tree.
355
356 =over 4
357
358 =item XXX-some-platform
359
360 XXX
361
362 =back
363
364 =head2 Discontinued Platforms
365
366 XXX List any platforms that this version of perl no longer compiles on.
367
368 =over 4
369
370 =item XXX-some-platform
371
372 XXX
373
374 =back
375
376 =head2 Platform-Specific Notes
377
378 XXX List any changes for specific platforms.  This could include configuration
379 and compilation changes or changes in portability/compatibility.  However,
380 changes within modules for platforms should generally be listed in the
381 L</Modules and Pragmata> section.
382
383 =over 4
384
385 =item XXX-some-platform
386
387 XXX
388
389 =back
390
391 =head1 Internal Changes
392
393 XXX Changes which affect the interface available to C<XS> code go here.  Other
394 significant internal changes for future core maintainers should be noted as
395 well.
396
397 [ List each change as a =item entry ]
398
399 =over 4
400
401 =item *
402
403 Added L<perlapi/sync_locale>.
404 Changing the program's locale should be avoided by XS code.  Nevertheless,
405 certain non-Perl libraries called from XS, such as C<Gtk> do so.  When this
406 happens, Perl needs to be told that the locale has changed.  Use this function
407 to do so, before returning to Perl.
408
409 =back
410
411 =head1 Selected Bug Fixes
412
413 XXX Important bug fixes in the core language are summarized here.  Bug fixes in
414 files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>.
415
416 [ List each fix as a =item entry ]
417
418 =over 4
419
420 =item *
421
422 Failing to compile C<use Foo> in an eval could leave a spurious
423 C<BEGIN> subroutine definition, which would produce a "Subroutine
424 BEGIN redefined" warning on the next use of C<use>, or other C<BEGIN>
425 block.  [perl #122107]
426
427 =item *
428
429 C<method { BLOCK } ARGS> syntax now correctly parses the arguments if they
430 begin with an opening brace.  [perl #46947]
431
432 =back
433
434 =head1 Known Problems
435
436 XXX Descriptions of platform agnostic bugs we know we can't fix go here.  Any
437 tests that had to be C<TODO>ed for the release would be noted here.  Unfixed
438 platform specific bugs also go here.
439
440 [ List each fix as a =item entry ]
441
442 =over 4
443
444 =item *
445
446 XXX
447
448 =back
449
450 =head1 Errata From Previous Releases
451
452 =over 4
453
454 =item *
455
456 XXX Add anything here that we forgot to add, or were mistaken about, in
457 the perldelta of a previous release.
458
459 =back
460
461 =head1 Obituary
462
463 XXX If any significant core contributor has died, we've added a short obituary
464 here.
465
466 =head1 Acknowledgements
467
468 XXX Generate this with:
469
470   perl Porting/acknowledgements.pl v5.21.2..HEAD
471
472 =head1 Reporting Bugs
473
474 If you find what you think is a bug, you might check the articles recently
475 posted to the comp.lang.perl.misc newsgroup and the perl bug database at
476 https://rt.perl.org/ .  There may also be information at
477 http://www.perl.org/ , the Perl Home Page.
478
479 If you believe you have an unreported bug, please run the L<perlbug> program
480 included with your release.  Be sure to trim your bug down to a tiny but
481 sufficient test case.  Your bug report, along with the output of C<perl -V>,
482 will be sent off to perlbug@perl.org to be analysed by the Perl porting team.
483
484 If the bug you are reporting has security implications, which make it
485 inappropriate to send to a publicly archived mailing list, then please send it
486 to perl5-security-report@perl.org.  This points to a closed subscription
487 unarchived mailing list, which includes all the core committers, who will be
488 able to help assess the impact of issues, figure out a resolution, and help
489 co-ordinate the release of patches to mitigate or fix the problem across all
490 platforms on which Perl is supported.  Please only use this address for
491 security issues in the Perl core, not for modules independently distributed on
492 CPAN.
493
494 =head1 SEE ALSO
495
496 The F<Changes> file for an explanation of how to view exhaustive details on
497 what changed.
498
499 The F<INSTALL> file for how to build Perl.
500
501 The F<README> file for general stuff.
502
503 The F<Artistic> and F<Copying> files for copyright information.
504
505 =cut