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