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