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