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