This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
[perl #114104] Better error for unterminated heredoc delim
[perl5.git] / pod / perldelta.pod
CommitLineData
44691e6f
AB
1=encoding utf8
2
3=head1 NAME
4
4eabcf70
TC
5[ this is a template for a new perldelta file. Any text flagged as
6XXX needs to be processed before release. ]
417a992d 7
4eabcf70 8perldelta - what is new for perl v5.17.3
e128ab2c 9
4eabcf70 10=head1 DESCRIPTION
6db9054f 11
4eabcf70
TC
12This document describes differences between the 5.17.2 release and
13the 5.17.3 release.
6db9054f 14
4eabcf70
TC
15If you are upgrading from an earlier release such as 5.17.1, first read
16L<perl5172delta>, which describes differences between 5.17.1 and
175.17.2.
ef7131e9 18
4eabcf70 19=head1 Notice
ff3f295c 20
4eabcf70 21XXX Any important notices here
95c6c5c5 22
4eabcf70 23=head1 Core Enhancements
95c6c5c5 24
4eabcf70
TC
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.
4c77591b 28
4eabcf70 29[ List each enhancement as a =head2 entry ]
c506fc7e 30
6ed07037
FC
31=head2 Computed Labels
32
33The loop controls C<next>, C<last> and C<redo>, and the special C<dump>
34operator, now allow arbitrary expressions to be used to compute labels at
35run time. Previously, any argument that was not a constant was treated as
36the empty string.
37
4eabcf70 38=head1 Security
36ab1671 39
4eabcf70
TC
40XXX Any security-related notices go here. In particular, any security
41vulnerabilities closed should be noted here rather than in the
42L</Selected Bug Fixes> section.
36ab1671 43
4eabcf70 44[ List each security issue as a =head2 entry ]
36ab1671 45
4eabcf70 46=head1 Incompatible Changes
df2c1bb8 47
613c63b4 48[ List each incompatible change as a =head2 entry ]
df2c1bb8 49
613c63b4 50=head2 C<$ENV{foo} = undef> deletes value from environ, like C<delete $ENV{foo}>
df2c1bb8 51
613c63b4
CS
52This facilitates use of C<local()> with C<%ENV> entries. In previous
53versions of Perl, C<undef> was converted to the empty string.
54
55=head2 Defined values stored in environment are forced to byte strings
56
57A value stored in an environment variable has always been stringified. In
58this release, it is converted to be only a byte string. First, it is forced
59to be a only a string. Then if the string is utf8 and the equivalent of
60C<utf8::downgrade> works, that result is used; otherwise, the equivalent of
61C<utf8::encode> is used, and a warning is issued about wide characters
62(L</Diagnostics>).
7ab2ea42 63
e7d41eaa
FC
64=head2 C<given> now aliases the global $_
65
66Instead of assigning to an implicit lexical $_, C<given> now makes the
67global $_ an alias for its argument, just like C<foreach>. However, it
68still uses lexical $_ if there is lexical $_ in scope (again, just like
69C<foreach>).
70
4eabcf70 71=head1 Deprecations
7ab2ea42 72
4eabcf70
TC
73XXX Any deprecated features, syntax, modules etc. should be listed here.
74In particular, deprecated modules should be listed here even if they are
75listed as an updated module in the L</Modules and Pragmata> section.
7ab2ea42 76
4eabcf70 77[ List each deprecation as a =head2 entry ]
7ab2ea42 78
4eabcf70 79=head1 Performance Enhancements
3be135d8 80
4eabcf70
TC
81XXX Changes which enhance performance without changing behaviour go here. There
82may well be none in a stable release.
3be135d8 83
4eabcf70 84[ List each enhancement as a =item entry ]
6db9054f 85
4eabcf70 86=over 4
6db9054f 87
7ca04d94
TC
88=item *
89
4eabcf70 90XXX
7ca04d94 91
e96e0834 92=back
c506fc7e 93
4eabcf70 94=head1 Modules and Pragmata
95c6c5c5 95
4eabcf70
TC
96XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
97go here. If Module::CoreList is updated, generate an initial draft of the
98following sections using F<Porting/corelist-perldelta.pl>, which prints stub
99entries to STDOUT. Results can be pasted in place of the '=head2' entries
100below. A paragraph summary for important changes should then be added by hand.
101In an ideal world, dual-life modules would have a F<Changes> file that could be
102cribbed.
95c6c5c5 103
4eabcf70
TC
104[ Within each section, list entries as a =item entry ]
105
106=head2 New Modules and Pragmata
95c6c5c5 107
e96e0834 108=over 4
95c6c5c5
JL
109
110=item *
111
4eabcf70 112XXX
95c6c5c5 113
e96e0834 114=back
95c6c5c5 115
4eabcf70 116=head2 Updated Modules and Pragmata
95c6c5c5 117
e96e0834 118=over 4
95c6c5c5 119
95c6c5c5
JL
120=item *
121
6b1793dd
NC
122L<B> has been upgraded from version 1.36 to version 1.37. All C<CVf_*> and
123C<GVf_*> and more SV-related flag values are now provided as constants in
124the C<B::> namespace and available for export. The default export list has
125not changed.
b8a55fe7 126
32ed16fc
FC
127=item *
128
129L<B::Deparse> has been upgraded from version 1.15 to 1.16. It now deparses
130loop controls with the correct precedence.
131
63870e6d
FC
132=item *
133
134L<Storable> has been upgraded from version 2.37 to 2.38. It can now freeze
135and thaw vstrings correctly. This causes a slight incompatible change in
136the storage format, so the format version has increased to 2.9.
137
e96e0834 138=back
95c6c5c5 139
4eabcf70 140=head2 Removed Modules and Pragmata
95c6c5c5 141
e96e0834 142=over 4
95c6c5c5 143
95c6c5c5
JL
144=item *
145
4eabcf70 146XXX
4f85bc45 147
4eabcf70 148=back
72267260 149
4eabcf70 150=head1 Documentation
72267260 151
4eabcf70
TC
152XXX Changes to files in F<pod/> go here. Consider grouping entries by
153file and be sure to link to the appropriate page, e.g. L<perlfunc>.
4f85bc45 154
4eabcf70 155=head2 New Documentation
7d101ed1 156
4eabcf70 157XXX Changes which create B<new> files in F<pod/> go here.
e013ada0 158
4eabcf70 159=head3 L<XXX>
4f85bc45 160
4eabcf70 161XXX Description of the purpose of the new file here
e013ada0 162
4eabcf70 163=head2 Changes to Existing Documentation
95c6c5c5 164
4eabcf70
TC
165XXX Changes which significantly change existing files in F<pod/> go here.
166However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
167section.
95c6c5c5 168
be28af6e 169=head3 L<perlfunc>, L<perlop>
95c6c5c5 170
e96e0834 171=over 4
95c6c5c5
JL
172
173=item *
174
be28af6e
FC
175Loop control verbs (C<dump>, C<goto>, C<next>, C<last> and C<redo>) have
176always had the same precedence as assignment operators, but this was never
177documented until now.
95c6c5c5 178
e96e0834 179=back
95c6c5c5 180
4eabcf70 181=head1 Diagnostics
05c8f9ed 182
4eabcf70
TC
183The following additions or changes have been made to diagnostic output,
184including warnings and fatal error messages. For the complete list of
185diagnostic messages, see L<perldiag>.
ceb0881c 186
4eabcf70
TC
187XXX New or changed warnings emitted by the core's C<C> code go here. Also
188include any changes in L<perldiag> that reconcile it to the C<C> code.
0998713f 189
4eabcf70
TC
190[ Within each section, list entries as a =item entry that links to perldiag,
191 e.g.
112b6866 192
4eabcf70 193 =item *
112b6866 194
4eabcf70
TC
195 L<Invalid version object|perldiag/"Invalid version object">
196]
42d72fc5 197
4eabcf70 198=head2 New Diagnostics
42d72fc5 199
4eabcf70 200XXX Newly added diagnostic messages go here
8e125188 201
613c63b4
CS
202=over 4
203
204=item *
205
206Attempts to put wide characters into environment variables via %ENV provoke
207the warning "Wide character in setenv".
208
209=back
210
4eabcf70 211=head3 New Errors
8e125188 212
e96e0834 213=over 4
e128ab2c 214
e2f0c3bb
FC
215=item *
216
4eabcf70 217XXX L<message|perldiag/"message">
16e4fcbf 218
4eabcf70 219=back
e2f0c3bb 220
4eabcf70 221=head3 New Warnings
90519d0f 222
4eabcf70 223=over 4
90519d0f
FC
224
225=item *
226
4eabcf70 227XXX L<message|perldiag/"message">
90519d0f 228
61174fb5 229=back
422287bf 230
4eabcf70
TC
231=head2 Changes to Existing Diagnostics
232
233XXX Changes (i.e. rewording) of diagnostic messages go here
2de6ba8d 234
e128ab2c
DM
235=over 4
236
237=item *
238
4eabcf70 239XXX Describe change here
e128ab2c 240
4eabcf70 241=back
8b1adbab 242
4eabcf70 243=head1 Utility Changes
8b1adbab 244
4eabcf70
TC
245XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go
246here. Most of these are built within the directories F<utils> and F<x2p>.
83f29afa 247
4eabcf70
TC
248[ List utility changes as a =head3 entry for each utility and =item
249entries for each change
250Use L<XXX> with program names to get proper documentation linking. ]
83f29afa 251
4eabcf70 252=head3 L<XXX>
0938f143 253
4eabcf70 254=over 4
0938f143 255
72267260
JL
256=item *
257
4eabcf70 258XXX
7a251f7a 259
4eabcf70 260=back
7a251f7a 261
4eabcf70 262=head1 Configuration and Compilation
21247d85 263
4eabcf70
TC
264XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
265go here. Any other changes to the Perl build process should be listed here.
266However, any platform-specific changes should be listed in the
267L</Platform Support> section, instead.
21247d85 268
4eabcf70 269[ List changes as a =item entry ].
2e4f8b82 270
4eabcf70 271=over 4
c95d4104 272
788505db
FC
273=item *
274
4eabcf70 275XXX
788505db 276
4eabcf70 277=back
2c2b9cf4 278
4eabcf70 279=head1 Testing
3cd56aaa 280
4eabcf70
TC
281XXX Any significant changes to the testing of a freshly built perl should be
282listed here. Changes which create B<new> files in F<t/> go here as do any
283large changes to the testing harness (e.g. when parallel testing was added).
284Changes to existing files in F<t/> aren't worth summarising, although the bugs
285that they represent may be covered elsewhere.
3cd56aaa 286
4eabcf70 287[ List each test improvement as a =item entry ]
3cd56aaa 288
4eabcf70 289=over 4
3cd56aaa
TC
290
291=item *
292
4eabcf70 293XXX
3cd56aaa 294
4eabcf70 295=back
3cd56aaa 296
4eabcf70 297=head1 Platform Support
3cd56aaa 298
4eabcf70 299XXX Any changes to platform support should be listed in the sections below.
3cd56aaa 300
4eabcf70
TC
301[ Within the sections, list each platform as a =item entry with specific
302changes as paragraphs below it. ]
3cd56aaa 303
4eabcf70 304=head2 New Platforms
3cd56aaa 305
4eabcf70
TC
306XXX List any platforms that this version of perl compiles on, that previous
307versions did not. These will either be enabled by new files in the F<hints/>
308directories, or new subdirectories and F<README> files at the top level of the
309source tree.
3cd56aaa 310
4eabcf70 311=over 4
3cd56aaa 312
4eabcf70 313=item XXX-some-platform
3cd56aaa 314
4eabcf70 315XXX
c0c19433 316
4eabcf70 317=back
c0c19433 318
4eabcf70 319=head2 Discontinued Platforms
7ab2ea42 320
4eabcf70 321XXX List any platforms that this version of perl no longer compiles on.
7ab2ea42 322
4eabcf70 323=over 4
7ab2ea42 324
4eabcf70 325=item XXX-some-platform
7ab2ea42 326
4eabcf70 327XXX
90519d0f 328
4eabcf70 329=back
90519d0f 330
4eabcf70 331=head2 Platform-Specific Notes
90519d0f 332
4eabcf70
TC
333XXX List any changes for specific platforms. This could include configuration
334and compilation changes or changes in portability/compatibility. However,
335changes within modules for platforms should generally be listed in the
336L</Modules and Pragmata> section.
90519d0f 337
4eabcf70 338=over 4
90519d0f 339
4eabcf70 340=item XXX-some-platform
90519d0f 341
4eabcf70 342XXX
90519d0f 343
4eabcf70 344=back
90519d0f 345
4eabcf70 346=head1 Internal Changes
90519d0f 347
4eabcf70
TC
348XXX Changes which affect the interface available to C<XS> code go here.
349Other significant internal changes for future core maintainers should
350be noted as well.
90519d0f 351
4eabcf70 352[ List each change as a =item entry ]
90519d0f 353
4eabcf70 354=over 4
90519d0f
FC
355
356=item *
357
4eabcf70 358XXX
90519d0f 359
4eabcf70 360=back
90519d0f 361
4eabcf70 362=head1 Selected Bug Fixes
90519d0f 363
4eabcf70
TC
364XXX Important bug fixes in the core language are summarised here.
365Bug fixes in files in F<ext/> and F<lib/> are best summarised in
366L</Modules and Pragmata>.
90519d0f 367
4eabcf70 368[ List each fix as a =item entry ]
90519d0f 369
4eabcf70 370=over 4
90519d0f
FC
371
372=item *
373
7a4d6ad6
KW
374C<\w> now matches the code points U+200C (ZERO WIDTH NON-JOINER) and
375U+200D (ZERO WIDTH JOINER). C<\W> no longer matches these. This change
376is because Unicode corrected their definition of what C<\w> should match.
90519d0f 377
77f5d539
FC
378=item *
379
380C<dump LABEL> no longer leaks its label.
381
3e81bef2
FC
382=item *
383
384Constant folding no longer changes the behaviour of functions like C<stat>
385and C<truncate> that can take either filenames or handles.
386C<stat 1 ? foo : bar> nows treats its argument as a file name (since it is
387an arbitrary expression), rather than the handle "foo".
388
e9f497c4
FC
389=item *
390
391C<truncate FOO, $len> no longer falls back to treating "FOO" as a file name
392if the filehandle has been deleted. This was broken in Perl 5.16.0.
393
d7f7c515
FC
394=item *
395
396Subroutine redefinitions after sub-to-glob and glob-to-glob assignments no
397longer cause double frees or panic messages.
398
afc04f16
FC
399=item *
400
401C<s///> now turns vstrings into plain strings when performing a
402substitution, even if the resulting string is the same (C<s/a/a/>).
403
b4cf37f5
FC
404=item *
405
406Prototype mismatch warnings no longer erroneously treat constant subs as
407having no prototype when they actually have "".
408
409=item *
410
411Constant subroutines and forward declarations no longer prevent prototype
412mismatch warnings from omitting the sub name.
413
ea9f761d
FC
414=item *
415
416C<undef> on a subroutine now clears call checkers.
417
70306497
FC
418=item *
419
420The C<ref> operator started leaking memory on blessed objects in Perl
4215.16.0. This has been fixed [perl #114340].
422
4eabcf70 423=back
90519d0f 424
4eabcf70 425=head1 Known Problems
b8a55fe7 426
4eabcf70
TC
427XXX Descriptions of platform agnostic bugs we know we can't fix go here. Any
428tests that had to be C<TODO>ed for the release would be noted here. Unfixed
429platform specific bugs also go here.
b8a55fe7 430
4eabcf70 431[ List each fix as a =item entry ]
b8a55fe7 432
4eabcf70 433=over 4
b8a55fe7
FC
434
435=item *
436
4eabcf70 437XXX
b8a55fe7 438
4eabcf70 439=back
5073ffbd 440
4eabcf70 441=head1 Obituary
5073ffbd 442
4eabcf70
TC
443XXX If any significant core contributor has died, we've added a short obituary
444here.
e128ab2c 445
61174fb5 446=head1 Acknowledgements
d5dc7001 447
4eabcf70
TC
448XXX Generate this with:
449
450 perl Porting/acknowledgements.pl v5.17.2..HEAD
29cf780c 451
44691e6f
AB
452=head1 Reporting Bugs
453
454If you find what you think is a bug, you might check the articles
52deee2e 455recently posted to the comp.lang.perl.misc newsgroup and the perl
f9001595
RS
456bug database at http://rt.perl.org/perlbug/ . There may also be
457information at http://www.perl.org/ , the Perl Home Page.
44691e6f
AB
458
459If you believe you have an unreported bug, please run the L<perlbug>
52deee2e
DR
460program included with your release. Be sure to trim your bug down
461to a tiny but sufficient test case. Your bug report, along with the
462output of C<perl -V>, will be sent off to perlbug@perl.org to be
463analysed by the Perl porting team.
44691e6f
AB
464
465If the bug you are reporting has security implications, which make it
f9001595
RS
466inappropriate to send to a publicly archived mailing list, then please send
467it to perl5-security-report@perl.org. This points to a closed subscription
468unarchived mailing list, which includes
469all the core committers, who will be able
470to help assess the impact of issues, figure out a resolution, and help
471co-ordinate the release of patches to mitigate or fix the problem across all
472platforms on which Perl is supported. Please only use this address for
473security issues in the Perl core, not for modules independently
474distributed on CPAN.
44691e6f
AB
475
476=head1 SEE ALSO
477
52deee2e
DR
478The F<Changes> file for an explanation of how to view exhaustive details
479on what changed.
44691e6f
AB
480
481The F<INSTALL> file for how to build Perl.
482
483The F<README> file for general stuff.
484
485The F<Artistic> and F<Copying> files for copyright information.
486
487=cut