This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
[perl #122703] ensure $! is set when chmod() and utime() fail
[perl5.git] / pod / perldelta.pod
CommitLineData
44691e6f
AB
1=encoding utf8
2
3=head1 NAME
4
86372193
A
5[ this is a template for a new perldelta file. Any text flagged as XXX needs
6to be processed before release. ]
7
8perldelta - what is new for perl v5.21.6
c68523cb 9
238894db 10=head1 DESCRIPTION
c68523cb 11
86372193 12This document describes differences between the 5.21.5 release and the 5.21.6
238894db 13release.
c68523cb 14
86372193
A
15If you are upgrading from an earlier release such as 5.21.4, first read
16L<perl5215delta>, which describes differences between 5.21.4 and 5.21.5.
8435afd1 17
86372193 18=head1 Notice
5cfa0642 19
86372193 20XXX Any important notices here
4cad5dc8 21
86372193 22=head1 Core Enhancements
4cad5dc8 23
86372193
A
24XXX New core language features go here. Summarize user-visible core language
25enhancements. Particularly prominent performance optimisations could go
26here, but most should go in the L</Performance Enhancements> section.
a5591204 27
86372193 28[ List each enhancement as a =head2 entry ]
a5591204 29
518159a1
TC
30=head2 List form of pipe open implemented for Win32
31
32The list form of pipe:
33
34 open my $fh, "-|", "program", @arguments;
35
36is now implemented on Win32. It has the same limitations as C<system
37LIST> on Win32, since the Win32 API doesn't accept program arguments
38as a list.
39
86372193 40=head1 Security
a5591204 41
86372193
A
42XXX Any security-related notices go here. In particular, any security
43vulnerabilities closed should be noted here rather than in the
44L</Selected Bug Fixes> section.
a5591204 45
86372193 46[ List each security issue as a =head2 entry ]
a5591204 47
86372193 48=head1 Incompatible Changes
a5591204 49
86372193 50XXX For a release on a stable branch, this section aspires to be:
a5591204 51
86372193
A
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.
b15c1b56 55
86372193 56[ List each incompatible change as a =head2 entry ]
b15c1b56 57
86372193 58=head1 Deprecations
bb8c7e27 59
86372193 60XXX Any deprecated features, syntax, modules etc. should be listed here.
bb8c7e27 61
86372193 62=head2 Module removals
bb8c7e27 63
86372193 64XXX Remove this section if inapplicable.
9a88d663 65
86372193
A
66The following modules will be removed from the core distribution in a
67future release, and will at that time need to be installed from CPAN.
68Distributions on CPAN which require these modules will need to list them as
69prerequisites.
9a88d663 70
86372193
A
71The core versions of these modules will now issue C<"deprecated">-category
72warnings to alert you to this fact. To silence these deprecation warnings,
73install the modules in question from CPAN.
5cfa0642 74
86372193
A
75Note that these are (with rare exceptions) fine modules that you are encouraged
76to continue to use. Their disinclusion from core primarily hinges on their
77necessity to bootstrapping a fully functional, CPAN-capable Perl installation,
78not usually on concerns over their design.
ba474e87 79
86372193 80=over
8435afd1 81
86372193 82=item XXX
d0ab07ee 83
86372193
A
84XXX Note that deprecated modules should be listed here even if they are listed
85as an updated module in the L</Modules and Pragmata> section.
cc4d09e1 86
86372193 87=back
cc4d09e1 88
86372193 89[ List each other deprecation as a =head2 entry ]
8435afd1 90
4475d0d2
KW
91=head2 Use of non-graphic characters in single-character variable names
92
93The syntax for single-character variable names is more lenient than
94for longer variable names, allowing the one-character name to be a
95punctuation character or even invisible (a non-graphic). Perl v5.20
96deprecated the ASCII-range controls as such a name. Now, all
97non-graphic characters that formerly were allowed are deprecated.
98The practical effect of this occurs only when not under C<S<"use
99utf8">>, and affects just the C1 controls (code points 0x80 through
1000xFF), NO-BREAK SPACE, and SOFT HYPHEN.
101
8c8d6154 102=head1 Performance Enhancements
5cfa0642 103
86372193
A
104XXX Changes which enhance performance without changing behaviour go here.
105There may well be none in a stable release.
5cfa0642 106
86372193 107[ List each enhancement as a =item entry ]
8435afd1 108
86372193 109=over 4
5cfa0642 110
5b306eef
DD
111=item *
112
86372193 113XXX
5b306eef 114
86372193 115=back
357205d5 116
86372193 117=head1 Modules and Pragmata
357205d5 118
86372193
A
119XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
120go here. If Module::CoreList is updated, generate an initial draft of the
121following sections using F<Porting/corelist-perldelta.pl>. A paragraph summary
122for important changes should then be added by hand. In an ideal world,
123dual-life modules would have a F<Changes> file that could be cribbed.
f704f251 124
86372193 125[ Within each section, list entries as a =item entry ]
f704f251 126
86372193 127=head2 New Modules and Pragmata
0cb3abac 128
86372193 129=over 4
0cb3abac 130
deec1830
FC
131=item *
132
86372193 133XXX
deec1830 134
8c8d6154 135=back
d0ab07ee 136
8c8d6154 137=head2 Updated Modules and Pragmata
d99849ae 138
39c4a6cf 139=over 4
d99849ae 140
ff433f2d
PM
141=item *
142
86372193 143L<XXX> has been upgraded from version A.xx to B.yy.
cbfcbc14 144
86372193 145=back
f348c3d8 146
86372193 147=head2 Removed Modules and Pragmata
f348c3d8 148
86372193 149=over 4
f348c3d8
A
150
151=item *
152
86372193 153XXX
f348c3d8 154
86372193 155=back
7635ad4d 156
86372193 157=head1 Documentation
7635ad4d 158
86372193
A
159XXX Changes to files in F<pod/> go here. Consider grouping entries by
160file and be sure to link to the appropriate page, e.g. L<perlfunc>.
7635ad4d 161
86372193 162=head2 New Documentation
f348c3d8 163
86372193 164XXX Changes which create B<new> files in F<pod/> go here.
f348c3d8 165
86372193 166=head3 L<XXX>
f4eedc6b 167
86372193 168XXX Description of the purpose of the new file here
f4eedc6b 169
86372193 170=head2 Changes to Existing Documentation
f4eedc6b 171
86372193
A
172XXX Changes which significantly change existing files in F<pod/> go here.
173However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
174section.
f348c3d8 175
42327f06 176=head3 L<perldata/Identifier parsing>
f348c3d8 177
86372193 178=over 4
f348c3d8
A
179
180=item *
181
42327f06
KW
182The syntax of single-character variable names has been brought
183up-to-date and more fully explained.
f348c3d8 184
86372193 185=back
f348c3d8 186
86372193 187=head1 Diagnostics
f348c3d8 188
86372193
A
189The following additions or changes have been made to diagnostic output,
190including warnings and fatal error messages. For the complete list of
191diagnostic messages, see L<perldiag>.
f348c3d8 192
86372193
A
193XXX New or changed warnings emitted by the core's C<C> code go here. Also
194include any changes in L<perldiag> that reconcile it to the C<C> code.
f348c3d8 195
86372193 196=head2 New Diagnostics
f348c3d8 197
86372193
A
198XXX Newly added diagnostic messages go under here, separated into New Errors
199and New Warnings
f348c3d8 200
86372193 201=head3 New Errors
84d03adf 202
86372193 203=over 4
ff433f2d 204
4cd408ba
TC
205=item *
206
86372193 207XXX L<message|perldiag/"message">
f348c3d8 208
86372193 209=back
f348c3d8 210
86372193 211=head3 New Warnings
f4eedc6b 212
86372193 213=over 4
f4eedc6b
DD
214
215=item *
216
4475d0d2 217L<Use of literal non-graphic characters in variable names is deprecated|perldiag/"Use of literal non-graphic characters in variable names is deprecated">
f348c3d8 218
86372193 219=back
0561e60b 220
86372193 221=head2 Changes to Existing Diagnostics
0561e60b 222
86372193 223XXX Changes (i.e. rewording) of diagnostic messages go here
0561e60b 224
86372193 225=over 4
4cd408ba 226
f348c3d8
A
227=item *
228
86372193 229XXX Describe change here
4cd408ba 230
86372193 231=back
40a81b59 232
86372193 233=head1 Utility Changes
f348c3d8 234
86372193
A
235XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here.
236Most of these are built within the directory F<utils>.
f348c3d8 237
86372193
A
238[ List utility changes as a =head2 entry for each utility and =item
239entries for each change
240Use L<XXX> with program names to get proper documentation linking. ]
f348c3d8 241
86372193 242=head2 L<XXX>
f348c3d8 243
86372193 244=over 4
f348c3d8
A
245
246=item *
247
86372193 248XXX
40a81b59 249
13900f93 250=back
aac7f82f 251
86372193 252=head1 Configuration and Compilation
2a395b86 253
86372193
A
254XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
255go here. Any other changes to the Perl build process should be listed here.
256However, any platform-specific changes should be listed in the
257L</Platform Support> section, instead.
8435afd1 258
86372193 259[ List changes as a =item entry ].
8435afd1
SH
260
261=over 4
2a395b86 262
12d22d1f
JK
263=item *
264
86372193 265XXX
12d22d1f 266
2a395b86
PM
267=back
268
86372193 269=head1 Testing
2a395b86 270
86372193
A
271XXX Any significant changes to the testing of a freshly built perl should be
272listed here. Changes which create B<new> files in F<t/> go here as do any
273large changes to the testing harness (e.g. when parallel testing was added).
274Changes to existing files in F<t/> aren't worth summarizing, although the bugs
275that they represent may be covered elsewhere.
2a395b86 276
86372193 277[ List each test improvement as a =item entry ]
5cfa0642 278
8c8d6154 279=over 4
2a395b86
PM
280
281=item *
282
86372193 283XXX
bb8c7e27 284
86372193 285=back
bb8c7e27 286
86372193 287=head1 Platform Support
bb8c7e27 288
86372193 289XXX Any changes to platform support should be listed in the sections below.
bb8c7e27 290
86372193
A
291[ Within the sections, list each platform as a =item entry with specific
292changes as paragraphs below it. ]
2a395b86 293
86372193 294=head2 New Platforms
6d9b7c7c 295
86372193
A
296XXX List any platforms that this version of perl compiles on, that previous
297versions did not. These will either be enabled by new files in the F<hints/>
298directories, or new subdirectories and F<README> files at the top level of the
299source tree.
363d3025 300
8c8d6154 301=over 4
334464b3 302
86372193 303=item XXX-some-platform
334464b3 304
86372193 305XXX
ef5a9509 306
363d3025
FC
307=back
308
86372193
A
309=head2 Discontinued Platforms
310
311XXX List any platforms that this version of perl no longer compiles on.
d72cd2eb 312
0346c3a9 313=over 4
375f5f06 314
86372193 315=item XXX-some-platform
2884baee 316
86372193 317XXX
6f1a844b 318
8c8d6154 319=back
549ea8d4 320
8c8d6154 321=head2 Platform-Specific Notes
aa292ef2 322
86372193
A
323XXX List any changes for specific platforms. This could include configuration
324and compilation changes or changes in portability/compatibility. However,
325changes within modules for platforms should generally be listed in the
326L</Modules and Pragmata> section.
327
8c8d6154 328=over 4
739e9bee 329
86372193 330=item XXX-some-platform
739e9bee 331
86372193 332XXX
b23b2fdb 333
8c8d6154 334=back
b23b2fdb 335
8c8d6154 336=head1 Internal Changes
7d15b1a8 337
86372193
A
338XXX Changes which affect the interface available to C<XS> code go here. Other
339significant internal changes for future core maintainers should be noted as
340well.
bbca64cf 341
86372193 342[ List each change as a =item entry ]
6ff8f256 343
86372193 344=over 4
28482d6c 345
28a42920
A
346=item *
347
86372193 348XXX
28a42920 349
8c8d6154 350=back
6ff8f256 351
8c8d6154 352=head1 Selected Bug Fixes
80cc3290 353
86372193
A
354XXX Important bug fixes in the core language are summarized here. Bug fixes in
355files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>.
13dd5671 356
86372193 357[ List each fix as a =item entry ]
bdab7676 358
86372193 359=over 4
db98db4e 360
8818afe8
TC
361=item *
362
86372193 363XXX
bb8c7e27 364
86372193 365=back
bb8c7e27 366
86372193 367=head1 Known Problems
bb8c7e27 368
86372193
A
369XXX Descriptions of platform agnostic bugs we know we can't fix go here. Any
370tests that had to be C<TODO>ed for the release would be noted here. Unfixed
371platform specific bugs also go here.
bb8c7e27 372
86372193 373[ List each fix as a =item entry ]
bb8c7e27 374
86372193 375=over 4
bb8c7e27 376
74f9f9ed
A
377=item *
378
86372193 379XXX
28a42920 380
86372193 381=back
28a42920 382
86372193 383=head1 Errata From Previous Releases
28a42920 384
86372193 385=over 4
28a42920
A
386
387=item *
388
86372193
A
389XXX Add anything here that we forgot to add, or were mistaken about, in
390the perldelta of a previous release.
28a42920 391
8c8d6154 392=back
3a085d00 393
86372193 394=head1 Obituary
01d42a22 395
86372193
A
396XXX If any significant core contributor has died, we've added a short obituary
397here.
01d42a22 398
86372193 399=head1 Acknowledgements
01d42a22 400
86372193 401XXX Generate this with:
01d42a22 402
86372193 403 perl Porting/acknowledgements.pl v5.21.5..HEAD
f5b73711 404
44691e6f
AB
405=head1 Reporting Bugs
406
e08634c5
SH
407If you find what you think is a bug, you might check the articles recently
408posted to the comp.lang.perl.misc newsgroup and the perl bug database at
238894db 409https://rt.perl.org/ . There may also be information at
7ef8b31d 410http://www.perl.org/ , the Perl Home Page.
44691e6f 411
e08634c5
SH
412If you believe you have an unreported bug, please run the L<perlbug> program
413included with your release. Be sure to trim your bug down to a tiny but
414sufficient test case. Your bug report, along with the output of C<perl -V>,
415will be sent off to perlbug@perl.org to be analysed by the Perl porting team.
44691e6f
AB
416
417If the bug you are reporting has security implications, which make it
e08634c5
SH
418inappropriate to send to a publicly archived mailing list, then please send it
419to perl5-security-report@perl.org. This points to a closed subscription
420unarchived mailing list, which includes all the core committers, who will be
421able to help assess the impact of issues, figure out a resolution, and help
f9001595 422co-ordinate the release of patches to mitigate or fix the problem across all
e08634c5
SH
423platforms on which Perl is supported. Please only use this address for
424security issues in the Perl core, not for modules independently distributed on
425CPAN.
44691e6f
AB
426
427=head1 SEE ALSO
428
e08634c5
SH
429The F<Changes> file for an explanation of how to view exhaustive details on
430what changed.
44691e6f
AB
431
432The F<INSTALL> file for how to build Perl.
433
434The F<README> file for general stuff.
435
436The F<Artistic> and F<Copying> files for copyright information.
437
438=cut