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