This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
document the append parameter to sv_gets [perl #72244]
[perl5.git] / pod / perldelta.pod
CommitLineData
44691e6f
AB
1=encoding utf8
2
3=head1 NAME
4
e96e0834
JL
5[ this is a template for a new perldelta file. Any text flagged as
6XXX needs to be processed before release. ]
27f00e3d 7
e96e0834 8perldelta - what is new for perl v5.17.2
417a992d 9
e96e0834 10=head1 DESCRIPTION
028c8719 11
e96e0834
JL
12This document describes differences between the 5.17.1 release and
13the 5.17.2 release.
028c8719 14
e96e0834
JL
15If you are upgrading from an earlier release such as 5.17.0, first read
16L<perl5171delta>, which describes differences between 5.17.0 and
175.17.1.
028c8719 18
e96e0834 19=head1 Notice
30608892 20
e96e0834 21XXX Any important notices here
e128ab2c 22
e96e0834 23=head1 Core Enhancements
e128ab2c 24
e96e0834
JL
25XXX New core language features go here. Summarise user-visible core language
26enhancements. Particularly prominent performance optimisations could go
27here, but most should go in the L</Performance Enhancements> section.
fe3193b5 28
e96e0834 29[ List each enhancement as a =head2 entry ]
05c8f9ed 30
e96e0834 31=head1 Security
0da72d5e 32
e96e0834
JL
33XXX Any security-related notices go here. In particular, any security
34vulnerabilities closed should be noted here rather than in the
35L</Selected Bug Fixes> section.
0da72d5e 36
e96e0834 37[ List each security issue as a =head2 entry ]
0da72d5e 38
e96e0834 39=head1 Incompatible Changes
0da72d5e 40
e96e0834 41XXX For a release on a stable branch, this section aspires to be:
0da72d5e 42
e96e0834
JL
43 There are no changes intentionally incompatible with 5.XXX.XXX
44 If any exist, they are bugs, and we request that you submit a
45 report. See L</Reporting Bugs> below.
0da72d5e 46
e96e0834 47[ List each incompatible change as a =head2 entry ]
e2f0c3bb 48
e96e0834 49=head1 Deprecations
e2f0c3bb 50
e96e0834
JL
51XXX Any deprecated features, syntax, modules etc. should be listed here.
52In particular, deprecated modules should be listed here even if they are
53listed as an updated module in the L</Modules and Pragmata> section.
7d101ed1 54
e96e0834 55[ List each deprecation as a =head2 entry ]
7d101ed1 56
e96e0834 57=head1 Performance Enhancements
7d101ed1 58
e96e0834
JL
59XXX Changes which enhance performance without changing behaviour go here. There
60may well be none in a stable release.
7d101ed1 61
e96e0834 62[ List each enhancement as a =item entry ]
95ce428c 63
f9001595 64=over 4
75ff5956 65
2630d42b 66=item *
c11980ad 67
e96e0834 68XXX
53de3ff0 69
61174fb5 70=back
ef7131e9 71
61174fb5 72=head1 Modules and Pragmata
ef7131e9 73
e96e0834
JL
74XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
75go here. If Module::CoreList is updated, generate an initial draft of the
76following sections using F<Porting/corelist-perldelta.pl>, which prints stub
77entries to STDOUT. Results can be pasted in place of the '=head2' entries
78below. A paragraph summary for important changes should then be added by hand.
79In an ideal world, dual-life modules would have a F<Changes> file that could be
80cribbed.
5cefbec9 81
e96e0834 82[ Within each section, list entries as a =item entry ]
fbdb83f3 83
e96e0834 84=head2 New Modules and Pragmata
95c6c5c5 85
e96e0834 86=over 4
9331f04e
NC
87
88=item *
89
e96e0834 90XXX
95c6c5c5 91
e96e0834 92=back
ff3f295c 93
e96e0834 94=head2 Updated Modules and Pragmata
ff3f295c 95
e96e0834 96=over 4
95c6c5c5 97
95c6c5c5
JL
98=item *
99
4c77591b
NC
100L<File::stat> has been upgraded from version 1.06 to 1.07.
101
102Previously C<File::stat>'s overloaded C<-x> and C<-X> operators did not give
103the correct results for directories or executable files when running as
104root. They had been treating executable permissions for root just like for
105any other user, performing group membership tests I<etc> for files not owned
106by root. They now follow the correct Unix behaviour - for a directory they
107are always true, and for a file if any of the three execute permission bits
108are set then they report that root can execute the file. Perl's builtin
109C<-x> and C<-X> operators have always been correct.
c506fc7e 110
36ab1671
FC
111=item *
112
113L<Tie::StdHandle> has been upgraded from version 4.2 to 4.3.
114
115C<READ> now respects the offset argument to C<read> [perl #112826].
116
df2c1bb8
TC
117=item *
118
119L<IO> has been upgraded from version 1.25_07 to 1.25_08.
120
121L<IO::Socket> tries harder to cache or otherwise fetch socket
122information.
123
e96e0834 124=back
c506fc7e 125
e96e0834 126=head2 Removed Modules and Pragmata
c506fc7e 127
e96e0834 128=over 4
95c6c5c5 129
95c6c5c5
JL
130=item *
131
e96e0834 132XXX
95c6c5c5 133
e96e0834 134=back
95c6c5c5 135
e96e0834 136=head1 Documentation
95c6c5c5 137
e96e0834
JL
138XXX Changes to files in F<pod/> go here. Consider grouping entries by
139file and be sure to link to the appropriate page, e.g. L<perlfunc>.
95c6c5c5 140
e96e0834 141=head2 New Documentation
1c633914 142
e96e0834 143XXX Changes which create B<new> files in F<pod/> go here.
f558db2f 144
e96e0834 145=head3 L<XXX>
66aa79e2 146
e96e0834 147XXX Description of the purpose of the new file here
95c6c5c5 148
e96e0834 149=head2 Changes to Existing Documentation
95c6c5c5 150
e96e0834
JL
151XXX Changes which significantly change existing files in F<pod/> go here.
152However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
153section.
95c6c5c5 154
66b30015 155=head3 L<perlfunc>
95c6c5c5 156
e96e0834 157=over 4
95c6c5c5
JL
158
159=item *
160
66b30015 161Clarified documentation of C<our>.
95c6c5c5 162
e96e0834 163=back
95c6c5c5 164
e96e0834 165=head1 Diagnostics
95c6c5c5 166
e96e0834
JL
167The following additions or changes have been made to diagnostic output,
168including warnings and fatal error messages. For the complete list of
169diagnostic messages, see L<perldiag>.
95c6c5c5 170
e96e0834
JL
171XXX New or changed warnings emitted by the core's C<C> code go here. Also
172include any changes in L<perldiag> that reconcile it to the C<C> code.
71014848 173
e96e0834
JL
174[ Within each section, list entries as a =item entry that links to perldiag,
175 e.g.
71014848 176
e96e0834 177 =item *
95c6c5c5 178
e96e0834
JL
179 L<Invalid version object|perldiag/"Invalid version object">
180]
95c6c5c5 181
e96e0834 182=head2 New Diagnostics
95c6c5c5 183
e96e0834 184XXX Newly added diagnostic messages go here
95c6c5c5 185
e96e0834 186=head3 New Errors
95c6c5c5 187
e96e0834 188=over 4
95c6c5c5 189
95c6c5c5
JL
190=item *
191
a9be10f4 192L<Group name must start with a non-digit word character in regex; marked by <-- HERE in mE<sol>%sE<sol>|perldiag/"Group name must start with a non-digit word character in regex; marked by <-- HERE in m/%s/">
40e43b78
FC
193
194This error has been added for C<(?&0)>, which is invalid. It used to
195produce an incomprehensible error message [perl #101666].
95c6c5c5 196
e96e0834 197=back
95c6c5c5 198
e96e0834 199=head3 New Warnings
95c6c5c5 200
e96e0834 201=over 4
95c6c5c5 202
95c6c5c5
JL
203=item *
204
72267260
JL
205C<chr()> now warns when passed a negative value [perl #83048].
206
207=item *
208
209C<srand()> now warns when passed a value that doesn't fit in a C<UV> (since the
210value will be truncated rather than overflowing) [perl #40605].
7d101ed1 211
e013ada0
JL
212=item *
213
214Running perl with the C<-i> flag now warns if no input files are provided on
215the command line [perl #113410].
216
e96e0834 217=back
d9661073 218
e96e0834 219=head2 Changes to Existing Diagnostics
95c6c5c5 220
e96e0834 221XXX Changes (i.e. rewording) of diagnostic messages go here
95c6c5c5 222
e96e0834 223=over 4
95c6c5c5
JL
224
225=item *
226
e96e0834 227XXX Describe change here
3630f57e 228
e96e0834 229=back
3630f57e 230
e96e0834 231=head1 Utility Changes
95c6c5c5 232
e96e0834
JL
233XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go
234here. Most of these are built within the directories F<utils> and F<x2p>.
95c6c5c5 235
e96e0834
JL
236[ List utility changes as a =head3 entry for each utility and =item
237entries for each change
238Use L<XXX> with program names to get proper documentation linking. ]
95c6c5c5 239
e96e0834 240=head3 L<XXX>
95c6c5c5 241
e96e0834 242=over 4
95c6c5c5
JL
243
244=item *
245
e96e0834 246XXX
95c6c5c5 247
e96e0834 248=back
95c6c5c5 249
e96e0834 250=head1 Configuration and Compilation
95c6c5c5 251
e96e0834
JL
252XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
253go here. Any other changes to the Perl build process should be listed here.
254However, any platform-specific changes should be listed in the
255L</Platform Support> section, instead.
95c6c5c5 256
e96e0834 257[ List changes as a =item entry ].
95c6c5c5 258
e96e0834 259=over 4
95c6c5c5
JL
260
261=item *
262
c5057b0f
FC
263Building perl with some Windows compilers used to fail due to a problem
264with miniperl's C<glob> operator (which uses the C<perlglob> program)
265deleting the PATH environment variable [perl #113798].
95c6c5c5 266
e96e0834 267=back
95c6c5c5 268
e96e0834 269=head1 Testing
95c6c5c5 270
e96e0834
JL
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 summarising, although the bugs
275that they represent may be covered elsewhere.
95c6c5c5 276
e96e0834 277[ List each test improvement as a =item entry ]
95c6c5c5 278
e96e0834 279=over 4
95c6c5c5
JL
280
281=item *
282
e96e0834 283XXX
95c6c5c5 284
61174fb5 285=back
f558db2f 286
e96e0834 287=head1 Platform Support
05c8f9ed 288
e96e0834 289XXX Any changes to platform support should be listed in the sections below.
05c8f9ed 290
e96e0834
JL
291[ Within the sections, list each platform as a =item entry with specific
292changes as paragraphs below it. ]
9dea6244 293
e96e0834 294=head2 New Platforms
9dea6244 295
e96e0834
JL
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.
7d101ed1
JL
300
301=over 4
302
b81e0e29 303=item *
7d101ed1 304
b81e0e29
DM
305Configure now always adds -qlanglvl=extc99 to the CC flags on AIX when
306using xlC. This will make it easier to compile a number of XS-based modules
307that assume C99 [perl #113778].
7d101ed1
JL
308
309=back
310
e96e0834 311=head2 Discontinued Platforms
ef7131e9 312
e96e0834 313XXX List any platforms that this version of perl no longer compiles on.
4a301309
FC
314
315=over 4
316
e96e0834 317=item XXX-some-platform
8dffc0ab 318
e96e0834 319XXX
dbc84d79 320
4a301309
FC
321=back
322
61174fb5 323=head2 Platform-Specific Notes
ceb0881c 324
e96e0834
JL
325XXX List any changes for specific platforms. This could include configuration
326and compilation changes or changes in portability/compatibility. However,
327changes within modules for platforms should generally be listed in the
328L</Modules and Pragmata> section.
89cbc6b8 329
e96e0834 330=over 4
0998713f 331
5edb02d0 332=item VMS
112b6866 333
5edb02d0
CB
334Quotes are now removed from the command verb (but not the parameters) for commands
335spawned via C<system>, backticks, or a piped C<open>. Previously, quotes on the verb
336were passed through to DCL, which would fail to recognize the command. Also, if the
337verb is actually a path to an image or command procedure on an ODS-5 volume, quoting it
338now allows the path to contain spaces.
112b6866 339
61174fb5 340=back
8e125188 341
61174fb5 342=head1 Internal Changes
8e125188 343
e96e0834
JL
344XXX Changes which affect the interface available to C<XS> code go here.
345Other significant internal changes for future core maintainers should
346be noted as well.
c4643160 347
e96e0834 348[ List each change as a =item entry ]
f8ef51fd 349
e96e0834 350=over 4
e128ab2c 351
e2f0c3bb
FC
352=item *
353
e96e0834 354XXX
e2f0c3bb 355
61174fb5 356=back
422287bf 357
61174fb5 358=head1 Selected Bug Fixes
2de6ba8d 359
e96e0834
JL
360XXX Important bug fixes in the core language are summarised here.
361Bug fixes in files in F<ext/> and F<lib/> are best summarised in
362L</Modules and Pragmata>.
52c4b146 363
e96e0834 364[ List each fix as a =item entry ]
e128ab2c
DM
365
366=over 4
367
368=item *
369
48895a0d
KW
370A regression introduced in v5.14.0 has been fixed, in which some calls
371to the C<re> module would clobber C<$_>.
e128ab2c 372
8b1adbab
JL
373=item *
374
375C<do FILE> now always either sets or clears C<$@>, even when the file can't be
376read. This ensures that testing C<$@> first (as recommended by the
377documentation) always returns the correct result.
378
83f29afa
VP
379=item *
380
381The array iterator used for the C<each @array> construct is now correctly
382reset when C<@array> is cleared (RT #75596). This happens for example when the
383array is globally assigned to, as in C<@array = (...)>, but not when its
384B<values> are assigned to. In terms of the XS API, it means that C<av_clear()>
385will now reset the iterator.
386
387This mirrors the behaviour of the hash iterator when the hash is cleared.
388
0938f143
JL
389=item *
390
391C<< $class->can >>, C<< $class->isa >>, and C<< $class->DOES >> now return
392correct results, regardless of whether that package referred to by C<$class>
393exists [perl #47113].
394
72267260
JL
395=item *
396
397Arriving signals no longer clear C<$@> [perl #45173].
398
7a251f7a
JL
399=item *
400
401Allow C<my ()> declarations with an empty variable list [perl #113554].
402
21247d85
FC
403=item *
404
405During parsing, subs declared after errors no longer leave stubs
406[perl #113712].
407
2e4f8b82
FC
408=item *
409
c95d4104
FC
410Closures containing no string evals no longer hang on to their containing
411subroutines, allowing variables closed over by outer subroutines to be
412freed when the outer sub is freed, even if the inner sub still exists
413[perl #89544].
414
788505db
FC
415=item *
416
417Duplication of in-memory filehandles by opening with a "<&=" or ">&=" mode
418stopped working properly in 5.16.0. It was causing the new handle to
419reference a different scalar variable. This has been fixed [perl #113764].
420
2c2b9cf4
FC
421=item *
422
423C<qr//> expressions no longer crash with custom regular expression engines
424that do not set C<offs> at regular expression compilation time
425[perl #112962].
426
3cd56aaa
TC
427=item *
428
429C<delete local> no longer crashes with certain magical arrays and hashes
430[perl #112966].
431
432=item *
433
434C<local> on elements of certain magical arrays and hashes used not to
435arrange to have the element deleted on scope exit, even if the element did
436not exist before C<local>.
437
438=item *
439
440C<scalar(write)> no longer returns multiple items [perl #73690].
441
442=item *
443
444String to floating point conversions no longer misparse certain strings under
445C<use locale> [perl #109318].
446
447=item *
448
449C<@INC> filters that die no longer leak memory [perl #92252].
450
451=item *
452
453The implementations of overloaded operations are now called in the correct
454context. This allows, among other things, being able to properly override
455C<< <> >> [perl #47119].
456
457=item *
458
459Specifying only the C<fallback> key when calling C<use overload> now behaves
460properly [perl #113010].
461
c0c19433
JL
462=item *
463
464C<< sub foo { my $a = 0; while ($a) { ... } } >> and
465C<< sub foo { while (0) { ... } } >> now return the same thing [perl #73618].
466
e128ab2c
DM
467=back
468
e96e0834 469=head1 Known Problems
dbc84d79 470
e96e0834
JL
471XXX Descriptions of platform agnostic bugs we know we can't fix go here. Any
472tests that had to be C<TODO>ed for the release would be noted here. Unfixed
473platform specific bugs also go here.
53de3ff0 474
e96e0834 475[ List each fix as a =item entry ]
233bba44
JL
476
477=over 4
478
479=item *
480
e96e0834 481XXX
233bba44 482
e96e0834 483=back
233bba44 484
e96e0834 485=head1 Obituary
233bba44 486
e96e0834
JL
487XXX If any significant core contributor has died, we've added a short obituary
488here.
233bba44 489
61174fb5 490=head1 Acknowledgements
d5dc7001 491
e96e0834
JL
492XXX Generate this with:
493
494 perl Porting/acknowledgements.pl v5.17.1..HEAD
29cf780c 495
44691e6f
AB
496=head1 Reporting Bugs
497
498If you find what you think is a bug, you might check the articles
52deee2e 499recently posted to the comp.lang.perl.misc newsgroup and the perl
f9001595
RS
500bug database at http://rt.perl.org/perlbug/ . There may also be
501information at http://www.perl.org/ , the Perl Home Page.
44691e6f
AB
502
503If you believe you have an unreported bug, please run the L<perlbug>
52deee2e
DR
504program included with your release. Be sure to trim your bug down
505to a tiny but sufficient test case. Your bug report, along with the
506output of C<perl -V>, will be sent off to perlbug@perl.org to be
507analysed by the Perl porting team.
44691e6f
AB
508
509If the bug you are reporting has security implications, which make it
f9001595
RS
510inappropriate to send to a publicly archived mailing list, then please send
511it to perl5-security-report@perl.org. This points to a closed subscription
512unarchived mailing list, which includes
513all the core committers, who will be able
514to help assess the impact of issues, figure out a resolution, and help
515co-ordinate the release of patches to mitigate or fix the problem across all
516platforms on which Perl is supported. Please only use this address for
517security issues in the Perl core, not for modules independently
518distributed on CPAN.
44691e6f
AB
519
520=head1 SEE ALSO
521
52deee2e
DR
522The F<Changes> file for an explanation of how to view exhaustive details
523on what changed.
44691e6f
AB
524
525The F<INSTALL> file for how to build Perl.
526
527The F<README> file for general stuff.
528
529The F<Artistic> and F<Copying> files for copyright information.
530
531=cut