This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
perldelta for #122829 / 00e40766a
[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.6
9
10 =head1 DESCRIPTION
11
12 This document describes differences between the 5.21.5 release and the 5.21.6
13 release.
14
15 If you are upgrading from an earlier release such as 5.21.4, first read
16 L<perl5215delta>, which describes differences between 5.21.4 and 5.21.5.
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 List form of pipe open implemented for Win32
31
32 The list form of pipe:
33
34   open my $fh, "-|", "program", @arguments;
35
36 is now implemented on Win32.  It has the same limitations as C<system
37 LIST> on Win32, since the Win32 API doesn't accept program arguments
38 as a list.
39
40 =head2 Assignment to list repetition
41
42 C<(...) x ...> can now be used within a list that is assigned to, as long
43 as the left-hand side is a valid lvalue.  This allows C<(undef,undef,$foo)
44 = that_function()> to be written as C<((undef)x2, $foo) = that_function()>.
45
46 =head1 Security
47
48 XXX Any security-related notices go here.  In particular, any security
49 vulnerabilities closed should be noted here rather than in the
50 L</Selected Bug Fixes> section.
51
52 [ List each security issue as a =head2 entry ]
53
54 =head1 Incompatible Changes
55
56 XXX For a release on a stable branch, this section aspires to be:
57
58     There are no changes intentionally incompatible with 5.XXX.XXX
59     If any exist, they are bugs, and we request that you submit a
60     report.  See L</Reporting Bugs> below.
61
62 [ List each incompatible change as a =head2 entry ]
63
64 =head1 Deprecations
65
66 XXX Any deprecated features, syntax, modules etc. should be listed here.
67
68 =head2 Module removals
69
70 XXX Remove this section if inapplicable.
71
72 The following modules will be removed from the core distribution in a
73 future release, and will at that time need to be installed from CPAN.
74 Distributions on CPAN which require these modules will need to list them as
75 prerequisites.
76
77 The core versions of these modules will now issue C<"deprecated">-category
78 warnings to alert you to this fact.  To silence these deprecation warnings,
79 install the modules in question from CPAN.
80
81 Note that these are (with rare exceptions) fine modules that you are encouraged
82 to continue to use.  Their disinclusion from core primarily hinges on their
83 necessity to bootstrapping a fully functional, CPAN-capable Perl installation,
84 not usually on concerns over their design.
85
86 =over
87
88 =item XXX
89
90 XXX Note that deprecated modules should be listed here even if they are listed
91 as an updated module in the L</Modules and Pragmata> section.
92
93 =back
94
95 [ List each other deprecation as a =head2 entry ]
96
97 =head2 Use of non-graphic characters in single-character variable names
98
99 The syntax for single-character variable names is more lenient than
100 for longer variable names, allowing the one-character name to be a
101 punctuation character or even invisible (a non-graphic).  Perl v5.20
102 deprecated the ASCII-range controls as such a name.  Now, all
103 non-graphic characters that formerly were allowed are deprecated.
104 The practical effect of this occurs only when not under C<S<"use
105 utf8">>, and affects just the C1 controls (code points 0x80 through
106 0xFF), NO-BREAK SPACE, and SOFT HYPHEN.
107
108 =head1 Performance Enhancements
109
110 XXX Changes which enhance performance without changing behaviour go here.
111 There may well be none in a stable release.
112
113 [ List each enhancement as a =item entry ]
114
115 =over 4
116
117 =item *
118
119 C<(...)x1>, C<("constant")x0> and C<($scalar)x0> are now optimised in list
120 context.  If the right-hand argument is a constant 1, the repetition
121 operator disappears.  If the right-hand argument is a constant 0, the whole
122 expressions is optimised to the empty list, so long as the left-hand
123 argument is a simple scalar or constant.  C<(foo())x0> is not optimised.
124
125 =back
126
127 =head1 Modules and Pragmata
128
129 XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
130 go here.  If Module::CoreList is updated, generate an initial draft of the
131 following sections using F<Porting/corelist-perldelta.pl>.  A paragraph summary
132 for important changes should then be added by hand.  In an ideal world,
133 dual-life modules would have a F<Changes> file that could be cribbed.
134
135 [ Within each section, list entries as a =item entry ]
136
137 =head2 New Modules and Pragmata
138
139 =over 4
140
141 =item *
142
143 XXX
144
145 =back
146
147 =head2 Updated Modules and Pragmata
148
149 =over 4
150
151 =item *
152
153 L<IO::Socket> has been upgraded from version 1.37 to 1.38.
154
155 Document the limitations of the isconnected() method.  [perl #123096]
156
157 =item *
158
159 L<DynaLoader> has been upgraded from version 1.27 to 1.28.
160
161 =back
162
163 =head2 Removed Modules and Pragmata
164
165 =over 4
166
167 =item *
168
169 XXX
170
171 =back
172
173 =head1 Documentation
174
175 XXX Changes to files in F<pod/> go here.  Consider grouping entries by
176 file and be sure to link to the appropriate page, e.g. L<perlfunc>.
177
178 =head2 New Documentation
179
180 XXX Changes which create B<new> files in F<pod/> go here.
181
182 =head3 L<XXX>
183
184 XXX Description of the purpose of the new file here
185
186 =head2 Changes to Existing Documentation
187
188 XXX Changes which significantly change existing files in F<pod/> go here.
189 However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
190 section.
191
192 =head3 L<perldata/Identifier parsing>
193
194 =over 4
195
196 =item *
197
198 The syntax of single-character variable names has been brought
199 up-to-date and more fully explained.
200
201 =back
202
203 =head1 Diagnostics
204
205 The following additions or changes have been made to diagnostic output,
206 including warnings and fatal error messages.  For the complete list of
207 diagnostic messages, see L<perldiag>.
208
209 XXX New or changed warnings emitted by the core's C<C> code go here.  Also
210 include any changes in L<perldiag> that reconcile it to the C<C> code.
211
212 =head2 New Diagnostics
213
214 XXX Newly added diagnostic messages go under here, separated into New Errors
215 and New Warnings
216
217 =head3 New Errors
218
219 =over 4
220
221 =item *
222
223 XXX L<message|perldiag/"message">
224
225 =back
226
227 =head3 New Warnings
228
229 =over 4
230
231 =item *
232
233 L<Use of literal non-graphic characters in variable names is deprecated|perldiag/"Use of literal non-graphic characters in variable names is deprecated">
234
235 =item *
236
237 A new C<locale> warning category has been created, with the following warning
238 messages currently in it:
239
240 =over 4
241
242 =item *
243
244 L<Locale '%s' may not work well.%s|perldiag/Locale '%s' may not work well.%s>
245
246 =item *
247
248 L<Can't do %s("%s") on non-UTF-8 locale; resolved to "%s".|perldiag/Can't do %s("%s") on non-UTF-8 locale; resolved to "%s".>
249
250 =back
251
252 =back
253
254 =head2 Changes to Existing Diagnostics
255
256 XXX Changes (i.e. rewording) of diagnostic messages go here
257
258 =over 4
259
260 =item *
261
262 L<Quantifier unexpected on zero-length expression in regex m/%s/|perldiag/"Quantifier unexpected on zero-length expression in regex m/%s/">.
263
264 This message has had the S<"<-- HERE"> marker removed, as it was always
265 placed at the end of the regular expression, regardless of where the
266 problem actually occurred.  [perl #122680]
267
268 =back
269
270 =head1 Utility Changes
271
272 XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here.
273 Most of these are built within the directory F<utils>.
274
275 [ List utility changes as a =head2 entry for each utility and =item
276 entries for each change
277 Use L<XXX> with program names to get proper documentation linking. ]
278
279 =head2 L<XXX>
280
281 =over 4
282
283 =item *
284
285 XXX
286
287 =back
288
289 =head1 Configuration and Compilation
290
291 XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
292 go here.  Any other changes to the Perl build process should be listed here.
293 However, any platform-specific changes should be listed in the
294 L</Platform Support> section, instead.
295
296 [ List changes as a =item entry ].
297
298 =over 4
299
300 =item *
301
302 F<Configure> with C<-Dmksymlinks> should now be faster. [perl #122002]
303
304 =back
305
306 =head1 Testing
307
308 XXX Any significant changes to the testing of a freshly built perl should be
309 listed here.  Changes which create B<new> files in F<t/> go here as do any
310 large changes to the testing harness (e.g. when parallel testing was added).
311 Changes to existing files in F<t/> aren't worth summarizing, although the bugs
312 that they represent may be covered elsewhere.
313
314 [ List each test improvement as a =item entry ]
315
316 =over 4
317
318 =item *
319
320 XXX
321
322 =back
323
324 =head1 Platform Support
325
326 XXX Any changes to platform support should be listed in the sections below.
327
328 [ Within the sections, list each platform as a =item entry with specific
329 changes as paragraphs below it. ]
330
331 =head2 New Platforms
332
333 XXX List any platforms that this version of perl compiles on, that previous
334 versions did not.  These will either be enabled by new files in the F<hints/>
335 directories, or new subdirectories and F<README> files at the top level of the
336 source tree.
337
338 =over 4
339
340 =item XXX-some-platform
341
342 XXX
343
344 =back
345
346 =head2 Discontinued Platforms
347
348 XXX List any platforms that this version of perl no longer compiles on.
349
350 =over 4
351
352 =item XXX-some-platform
353
354 XXX
355
356 =back
357
358 =head2 Platform-Specific Notes
359
360 XXX List any changes for specific platforms.  This could include configuration
361 and compilation changes or changes in portability/compatibility.  However,
362 changes within modules for platforms should generally be listed in the
363 L</Modules and Pragmata> section.
364
365 =over 4
366
367 =item XXX-some-platform
368
369 XXX
370
371 =back
372
373 =head3 Win32
374
375 =over 4
376
377 =item *
378
379 In the experimental C<:win32> layer, a crash in C<open> was fixed. Also
380 opening C</dev/null>, which works the Win32 Perl's normal C<:unix> layer, was
381 implemented for C<:win32>.
382 L<[perl #122224]|https://rt.perl.org/Ticket/Display.html?id=122224>
383
384 =item *
385
386 A new makefile option, C<USE_LONG_DOUBLE>, has been added to the Windows
387 dmake makefile for gcc builds only.  Set this to "define" if you want perl to
388 use long doubles to give more accuracy and range for floating point numbers.
389
390 =back
391
392 =head1 Internal Changes
393
394 XXX Changes which affect the interface available to C<XS> code go here.  Other
395 significant internal changes for future core maintainers should be noted as
396 well.
397
398 [ List each change as a =item entry ]
399
400 =over 4
401
402 =item *
403
404 C<screaminstr> has been removed. Although marked as public API, it is
405 undocumented and has no usage in modern perl versions on CPAN Grep. Calling it
406 has been fatal since 5.17.0.
407
408 =item *
409
410 C<newDEFSVOP>, C<block_start>, C<block_end> and C<intro_my> have been added
411 to the API.
412
413 =item *
414
415 The internal C<convert> function in F<op.c> has been renamed
416 C<op_convert_list> and added to the API.
417
418 =back
419
420 =head1 Selected Bug Fixes
421
422 XXX Important bug fixes in the core language are summarized here.  Bug fixes in
423 files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>.
424
425 [ List each fix as a =item entry ]
426
427 =over 4
428
429 =item *
430
431 fchmod() and futimes() now set C<$!> when they fail due to being
432 passed a closed file handle.  [perl #122703]
433
434 =item *
435
436 Perl now comes with a corrected Unicode 7.0 for the erratum issued on
437 October 21, 2014 (see L<http://www.unicode.org/errata/#current_errata>),
438 dealing with glyph shaping in Arabic.
439
440 =item *
441
442 op_free() no longer crashes due to a stack overflow when freeing a
443 deeply recursive op tree. [perl #108276]
444
445 =item *
446
447 scalarvoid() would crash due to a stack overflow when processing a
448 deeply recursive op tree. [perl #108276]
449
450 =item *
451
452 In Perl 5.20.0, C<$^N> accidentally had the internal UTF8 flag turned off
453 if accessed from a code block within a regular expression, effectively
454 UTF8-encoding the value.  This has been fixed.  [perl #123135]
455
456 =item *
457
458 A failed C<semctl> call no longer overwrites existing items on the stack,
459 causing C<(semctl(-1,0,0,0))[0]> to give an "uninitialized" warning.
460
461 =item *
462
463 C<else{foo()}> with no space before C<foo> is now better at assigning the
464 right line number to that statement.  [perl #122695]
465
466 =item *
467
468 Sometimes the assignment in C<@array = split> gets optimised and C<split>
469 itself writes directly to the array.  This caused a bug, preventing this
470 assignment from being used in lvalue context.  So
471 C<(@a=split//,"foo")=bar()> was an error.  (This bug probably goes back to
472 Perl 3, when the optimisation was added.)  This optimisation, and the bug,
473 started to happen in more cases in 5.21.5.  It has now been fixed.
474 [perl #123057]
475
476 =item *
477
478 When argument lists that fail the checks installed by subroutine
479 signatures, the resulting error messages now give the file and line number
480 of the caller, not of the called subroutine.  [perl #121374]
481
482 =item *
483
484 Flip-flop operators (C<..> and C<...> in scalar context) used to maintain
485 a separate state for each recursion level (the number of times the
486 enclosing sub was called recursively), contrary to the documentation.  Now
487 each closure has one internal state for each flip-flop.  [perl #122829]
488
489 =back
490
491 =head1 Known Problems
492
493 XXX Descriptions of platform agnostic bugs we know we can't fix go here.  Any
494 tests that had to be C<TODO>ed for the release would be noted here.  Unfixed
495 platform specific bugs also go here.
496
497 [ List each fix as a =item entry ]
498
499 =over 4
500
501 =item *
502
503 Starting in 5.21.6, accessing L<perlapi/CvPADLIST> in an XSUB is forbidden.
504 CvPADLIST has be reused for a different internal purpose for XSUBs. Guard all
505 CvPADLIST expressions with C<CvISXSUB()> if your code doesn't already block
506 XSUB CV*s from going through optree CV* expecting code.
507
508 =back
509
510 =head1 Errata From Previous Releases
511
512 =over 4
513
514 =item *
515
516 Due to a mistake in the string-copying logic, copying the value of a state
517 variable could instead steal the value and undefine the variable.  This
518 bug, introduced in 5.20, would happen mostly for long strings (1250 chars
519 or more), but could happen for any strings under builds with copy-on-write
520 disabled.  [perl #123029]
521
522 This bug was actually fixed in 5.21.5, but it was not until after that
523 release that this bug, and the fact that it had been fixed, were
524 discovered.
525
526 =back
527
528 =head1 Obituary
529
530 XXX If any significant core contributor has died, we've added a short obituary
531 here.
532
533 =head1 Acknowledgements
534
535 XXX Generate this with:
536
537   perl Porting/acknowledgements.pl v5.21.5..HEAD
538
539 =head1 Reporting Bugs
540
541 If you find what you think is a bug, you might check the articles recently
542 posted to the comp.lang.perl.misc newsgroup and the perl bug database at
543 https://rt.perl.org/ .  There may also be information at
544 http://www.perl.org/ , the Perl Home Page.
545
546 If you believe you have an unreported bug, please run the L<perlbug> program
547 included with your release.  Be sure to trim your bug down to a tiny but
548 sufficient test case.  Your bug report, along with the output of C<perl -V>,
549 will be sent off to perlbug@perl.org to be analysed by the Perl porting team.
550
551 If the bug you are reporting has security implications, which make it
552 inappropriate to send to a publicly archived mailing list, then please send it
553 to perl5-security-report@perl.org.  This points to a closed subscription
554 unarchived mailing list, which includes all the core committers, who will be
555 able to help assess the impact of issues, figure out a resolution, and help
556 co-ordinate the release of patches to mitigate or fix the problem across all
557 platforms on which Perl is supported.  Please only use this address for
558 security issues in the Perl core, not for modules independently distributed on
559 CPAN.
560
561 =head1 SEE ALSO
562
563 The F<Changes> file for an explanation of how to view exhaustive details on
564 what changed.
565
566 The F<INSTALL> file for how to build Perl.
567
568 The F<README> file for general stuff.
569
570 The F<Artistic> and F<Copying> files for copyright information.
571
572 =cut