This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
perldelta for f605e527
[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.8
9
10 =head1 DESCRIPTION
11
12 This document describes differences between the 5.21.7 release and the 5.21.8
13 release.
14
15 If you are upgrading from an earlier release such as 5.21.6, first read
16 L<perl5217delta>, which describes differences between 5.21.6 and 5.21.7.
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 =head2 The warnings pragma now supports warnings outside of "all"
31
32 Ever since perl v5.6.0 we've had no way of adding new warnings without
33 retroactively adding them to all existing programs that used C<-w>,
34 C<-W> or C<use warnings>.
35
36 This caused us to not add new useful warnings out of fear that they
37 might unduly burden users who just wanted to upgrade perl and didn't
38 want to deal with a bunch of warnings from their existing code.
39
40 We now support a way to have our cake and eat it too, and can add new
41 warnings to the core going forward through other top-level warning
42 categories. See L<the warnings documentation|warnings/Top-level
43 warning categories & associated confusion> for details.
44
45 =head2 Non-Capturing Regular Expression Flag
46
47 Regular expressions now support a C</n> flag that disables capturing
48 and filling in C<$1>, C<$2>, etc... inside of groups:
49
50   "hello" =~ /(hi|hello)/n; # $1 is not set
51
52 This is equivalent to putting C<?:> at the beginning of every capturing group.
53
54 See L<perlre/"n"> for more information.
55
56 =head2 C<prototype> with no arguments
57
58 C<prototype()> with no arguments now infers C<$_>.  [perl #123514]
59
60 =head1 Security
61
62 XXX Any security-related notices go here.  In particular, any security
63 vulnerabilities closed should be noted here rather than in the
64 L</Selected Bug Fixes> section.
65
66 [ List each security issue as a =head2 entry ]
67
68 =head1 Incompatible Changes
69
70 XXX For a release on a stable branch, this section aspires to be:
71
72     There are no changes intentionally incompatible with 5.XXX.XXX
73     If any exist, they are bugs, and we request that you submit a
74     report.  See L</Reporting Bugs> below.
75
76 [ List each incompatible change as a =head2 entry ]
77
78 =head1 Deprecations
79
80 XXX Any deprecated features, syntax, modules etc. should be listed here.
81
82 =head2 Module removals
83
84 XXX Remove this section if inapplicable.
85
86 The following modules will be removed from the core distribution in a
87 future release, and will at that time need to be installed from CPAN.
88 Distributions on CPAN which require these modules will need to list them as
89 prerequisites.
90
91 The core versions of these modules will now issue C<"deprecated">-category
92 warnings to alert you to this fact.  To silence these deprecation warnings,
93 install the modules in question from CPAN.
94
95 Note that these are (with rare exceptions) fine modules that you are encouraged
96 to continue to use.  Their disinclusion from core primarily hinges on their
97 necessity to bootstrapping a fully functional, CPAN-capable Perl installation,
98 not usually on concerns over their design.
99
100 =over
101
102 =item XXX
103
104 XXX Note that deprecated modules should be listed here even if they are listed
105 as an updated module in the L</Modules and Pragmata> section.
106
107 =back
108
109 [ List each other deprecation as a =head2 entry ]
110
111 =head1 Performance Enhancements
112
113 XXX Changes which enhance performance without changing behaviour go here.
114 There may well be none in a stable release.
115
116 [ List each enhancement as a =item entry ]
117
118 =over 4
119
120 =item *
121
122 XXX
123
124 =back
125
126 =head1 Modules and Pragmata
127
128 XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
129 go here.  If Module::CoreList is updated, generate an initial draft of the
130 following sections using F<Porting/corelist-perldelta.pl>.  A paragraph summary
131 for important changes should then be added by hand.  In an ideal world,
132 dual-life modules would have a F<Changes> file that could be cribbed.
133
134 [ Within each section, list entries as a =item entry ]
135
136 =head2 New Modules and Pragmata
137
138 =over 4
139
140 =item *
141
142 XXX
143
144 =back
145
146 =head2 Updated Modules and Pragmata
147
148 =over 4
149
150 =item *
151
152 L<XXX> has been upgraded from version A.xx to B.yy.
153
154 =item *
155
156 L<attributes> has been upgraded from version 0.24 to 0.25.
157
158 Minor internal change only.
159
160 =item *
161
162 L<B> has been upgraded from version 1.54 to 1.55.
163
164 A bug where, after an ithread creation or psuedofork, special/immortal SVs in
165 the child ithread/psuedoprocess did not have the correct class of
166 C<B::SPECIAL>, has been fixed.
167
168 The C<id> and C<outid> PADLIST methods have been added.
169
170 =item *
171
172 L<B::Deparse> has been upgraded from version 1.31 to 1.32.
173
174 Deparsing C<BEGIN { undef &foo }> with the B<-w> switch enabled started to
175 emit 'uninitialized' warnings in Perl 5.14.  This has been fixed.
176
177 Deparsing calls to subs with a C<(;+)> prototype resulted in an infinite
178 loop.  The C<(;$>) C<(_)> and C<(;_)> prototypes were given the wrong
179 precedence, causing C<foo($a<$b)> to be deparsed without the parentheses.
180
181 =item *
182
183 L<Safe> has been upgraded from version 2.38 to 2.39.
184
185 C<reval> was not propagating void context properly.
186
187 =back
188
189 =head2 Removed Modules and Pragmata
190
191 =over 4
192
193 =item *
194
195 XXX
196
197 =back
198
199 =head1 Documentation
200
201 XXX Changes to files in F<pod/> go here.  Consider grouping entries by
202 file and be sure to link to the appropriate page, e.g. L<perlfunc>.
203
204 =head2 New Documentation
205
206 XXX Changes which create B<new> files in F<pod/> go here.
207
208 =head3 L<XXX>
209
210 XXX Description of the purpose of the new file here
211
212 =head2 Changes to Existing Documentation
213
214 XXX Changes which significantly change existing files in F<pod/> go here.
215 However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
216 section.
217
218 =head3 L<XXX>
219
220 =over 4
221
222 =item *
223
224 XXX Description of the change here
225
226 =back
227
228 =head1 Diagnostics
229
230 The following additions or changes have been made to diagnostic output,
231 including warnings and fatal error messages.  For the complete list of
232 diagnostic messages, see L<perldiag>.
233
234 XXX New or changed warnings emitted by the core's C<C> code go here.  Also
235 include any changes in L<perldiag> that reconcile it to the C<C> code.
236
237 =head2 New Diagnostics
238
239 XXX Newly added diagnostic messages go under here, separated into New Errors
240 and New Warnings
241
242 =head3 New Errors
243
244 =over 4
245
246 =item *
247
248 XXX L<message|perldiag/"message">
249
250 =back
251
252 =head3 New Warnings
253
254 =over 4
255
256 =item *
257
258 XXX L<message|perldiag/"message">
259
260 =item *
261
262 L<Wide character (U+%X) in %s|perldiag/"Wide character (U+%X) in %s">
263
264 =back
265
266 =head2 Changes to Existing Diagnostics
267
268 XXX Changes (i.e. rewording) of diagnostic messages go here
269
270 =over 4
271
272 =item *
273
274 XXX Describe change here
275
276 The message
277 L<Locale '%s' may not work well.%s|perldiag/"Locale '%s' may not work well.%s">
278 is no longer raised unless the problemtatic locale is actually used in
279 the Perl program.  Previously it was raised if it merely was the
280 underlying locale.  All Perl programs have an underlying locale at all
281 times, but something like a C<S<use locale>> is needed for that locale
282 to actually have some effect.  This message will not be raised when
283 the underlying locale is hidden.
284
285 =back
286
287 =head1 Utility Changes
288
289 XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here.
290 Most of these are built within the directory F<utils>.
291
292 [ List utility changes as a =head2 entry for each utility and =item
293 entries for each change
294 Use L<XXX> with program names to get proper documentation linking. ]
295
296 =head2 L<XXX>
297
298 =over 4
299
300 =item *
301
302 XXX
303
304 =back
305
306 =head1 Configuration and Compilation
307
308 XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
309 go here.  Any other changes to the Perl build process should be listed here.
310 However, any platform-specific changes should be listed in the
311 L</Platform Support> section, instead.
312
313 [ List changes as a =item entry ].
314
315 =over 4
316
317 =item *
318
319 XXX
320
321 =back
322
323 =head1 Testing
324
325 XXX Any significant changes to the testing of a freshly built perl should be
326 listed here.  Changes which create B<new> files in F<t/> go here as do any
327 large changes to the testing harness (e.g. when parallel testing was added).
328 Changes to existing files in F<t/> aren't worth summarizing, although the bugs
329 that they represent may be covered elsewhere.
330
331 [ List each test improvement as a =item entry ]
332
333 =over 4
334
335 =item *
336
337 XXX
338
339 =back
340
341 =head1 Platform Support
342
343 XXX Any changes to platform support should be listed in the sections below.
344
345 [ Within the sections, list each platform as a =item entry with specific
346 changes as paragraphs below it. ]
347
348 =head2 New Platforms
349
350 XXX List any platforms that this version of perl compiles on, that previous
351 versions did not.  These will either be enabled by new files in the F<hints/>
352 directories, or new subdirectories and F<README> files at the top level of the
353 source tree.
354
355 =over 4
356
357 =item XXX-some-platform
358
359 XXX
360
361 =back
362
363 =head2 Discontinued Platforms
364
365 XXX List any platforms that this version of perl no longer compiles on.
366
367 =over 4
368
369 =item XXX-some-platform
370
371 XXX
372
373 =back
374
375 =head2 Platform-Specific Notes
376
377 XXX List any changes for specific platforms.  This could include configuration
378 and compilation changes or changes in portability/compatibility.  However,
379 changes within modules for platforms should generally be listed in the
380 L</Modules and Pragmata> section.
381
382 =over 4
383
384 =item Win32
385
386 =over 4
387
388 =item *
389
390 Previously, on Visual C++ for Win64 built Perls only, when compiling every Perl
391 XS module (including CPAN ones) and Perl aware .c file with a 64 bit Visual C++,
392 would uncondtionally have around a dozen warnings from hv_func.h.  These
393 warnings have been silenced.  GCC all bitness and Visual C++ for Win32 were
394 not affected.
395
396 =item *
397
398 Support for building without PerlIO has been removed from the Windows
399 makefiles.  Non-PerlIO builds were all but deprecated in Perl 5.18.0 and are
400 already not supported by F<Configure> on POSIX systems.
401
402 =item *
403
404 Between 2 and 6 ms and 7 I/O calls have been saved per attempt to open a perl
405 module for each path in C<@INC>.
406
407 =back
408
409 =back
410
411 =head1 Internal Changes
412
413 XXX Changes which affect the interface available to C<XS> code go here.  Other
414 significant internal changes for future core maintainers should be noted as
415 well.
416
417 [ List each change as a =item entry ]
418
419 =over 4
420
421 =item *
422
423 Added Perl_sv_get_backrefs() to determine if an SV is a weak-referent.
424
425 Function either returns an SV * of type AV, which contains the set of
426 weakreferences which reference the passed in SV, or a simple RV * which
427 is the only weakref to this item.
428
429 =item *
430
431 C<gv_add_by_type> which was added to public API in 5.11.0 but undocumented and
432 shows no CPAN usage has been removed from public API. Please use public API
433 C<GvSVn> C<GvIOn> C<GvAVn> and C<GvHVn> for adding elements to a GV.
434
435 =item *
436
437 C<GvSVn> C<GvIOn> C<GvAVn> and C<GvHVn> have been made rvalues, previously they
438 were lvalues. If you are assigning a SV to C<GvSVn> C<GvIOn> C<GvAVn> and
439 C<GvHVn> you are leaking memory. If you want an lvalue, use C<GvSV> C<GvIO>
440 C<GvAV> and C<GvHV>.
441
442 =item *
443
444 XXX
445
446 =back
447
448 =head1 Selected Bug Fixes
449
450 XXX Important bug fixes in the core language are summarized here.  Bug fixes in
451 files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>.
452
453 [ List each fix as a =item entry ]
454
455 =over 4
456
457 =item *
458
459 A bug in regular expression patterns that could lead to segfaults and
460 other crashes has been fixed.  This occurred only in patterns compiled
461 with C<"/i">, while taking into account the current POSIX locale (this usually
462 means they have to be compiled within the scope of C<S<"use locale">>),
463 and there must be a string of at least 128 consecutive bytes to match.
464 [perl #123539]
465
466 =item *
467
468 C<s///> now works on very long strings instead of dying with 'Substitution
469 loop'.  [perl #103260] [perl #123071]
470
471 =item *
472
473 C<gmtime> no longer crashes with not-a-number values.  [perl #123495]
474
475 =item *
476
477 C<\()> (reference to an empty list) and C<y///> with lexical $_ in scope
478 could do a bad write past the end of the stack.  They have been fixed
479 to extend the stack first.
480
481 =item *
482
483 C<prototype()> with no arguments used to read the previous item on the
484 stack, so C<print "foo", prototype()> would print foo's prototype.  It has
485 been fixed to infer $_ instead.  [perl #123514]
486
487 =back
488
489 =head1 Known Problems
490
491 XXX Descriptions of platform agnostic bugs we know we can't fix go here.  Any
492 tests that had to be C<TODO>ed for the release would be noted here.  Unfixed
493 platform specific bugs also go here.
494
495 [ List each fix as a =item entry ]
496
497 =over 4
498
499 =item *
500
501 XXX
502
503 =back
504
505 =head1 Errata From Previous Releases
506
507 =over 4
508
509 =item *
510
511 XXX Add anything here that we forgot to add, or were mistaken about, in
512 the perldelta of a previous release.
513
514 =back
515
516 =head1 Obituary
517
518 XXX If any significant core contributor has died, we've added a short obituary
519 here.
520
521 =head1 Acknowledgements
522
523 XXX Generate this with:
524
525   perl Porting/acknowledgements.pl v5.21.7..HEAD
526
527 =head1 Reporting Bugs
528
529 If you find what you think is a bug, you might check the articles recently
530 posted to the comp.lang.perl.misc newsgroup and the perl bug database at
531 https://rt.perl.org/ .  There may also be information at
532 http://www.perl.org/ , the Perl Home Page.
533
534 If you believe you have an unreported bug, please run the L<perlbug> program
535 included with your release.  Be sure to trim your bug down to a tiny but
536 sufficient test case.  Your bug report, along with the output of C<perl -V>,
537 will be sent off to perlbug@perl.org to be analysed by the Perl porting team.
538
539 If the bug you are reporting has security implications, which make it
540 inappropriate to send to a publicly archived mailing list, then please send it
541 to perl5-security-report@perl.org.  This points to a closed subscription
542 unarchived mailing list, which includes all the core committers, who will be
543 able to help assess the impact of issues, figure out a resolution, and help
544 co-ordinate the release of patches to mitigate or fix the problem across all
545 platforms on which Perl is supported.  Please only use this address for
546 security issues in the Perl core, not for modules independently distributed on
547 CPAN.
548
549 =head1 SEE ALSO
550
551 The F<Changes> file for an explanation of how to view exhaustive details on
552 what changed.
553
554 The F<INSTALL> file for how to build Perl.
555
556 The F<README> file for general stuff.
557
558 The F<Artistic> and F<Copying> files for copyright information.
559
560 =cut