This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Upgrade Unicode-Collate from version 1.12 to 1.14
[perl5.git] / pod / perldelta.pod
CommitLineData
44691e6f
AB
1=encoding utf8
2
3=head1 NAME
4
fc4c3cec
RS
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.23.1
eabfc7bc 9
2cfe9b50 10=head1 DESCRIPTION
eabfc7bc 11
fc4c3cec 12This document describes differences between the 5.23.0 release and the 5.23.1
2cfe9b50 13release.
eabfc7bc 14
fc4c3cec
RS
15If you are upgrading from an earlier release such as 5.22.0, first read
16L<perl5230delta>, which describes differences between 5.22.0 and 5.23.0.
17
18=head1 Notice
19
20XXX Any important notices here
21
2cfe9b50 22=head1 Core Enhancements
eabfc7bc 23
fc4c3cec
RS
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.
ac71d2a0 27
fc4c3cec 28[ List each enhancement as a =head2 entry ]
ac71d2a0 29
deaaea8c
JH
30=head2 Integer shift (C<< << >> and C<< >> >>) now explicitly defined
31
32Negative shifts are reverse shifts: left shift becomes right shift,
33and right shift becomes left shift.
34
35Shifting by the number of bits in a native integer (or more) is zero,
36except when the "overshift" is right shifting a negative value under
37C<use integer>, in which case the result is -1 (arithmetic shift).
38
39Until now negative shifting and overshifting have been undefined
40because they have relied on whatever the C implementation happens
41to do. For example, for the "overshift" a common behavior C is
42"modulo shift":
43
44 1 >> 64 == 1 >> (64 % 64) == 1 >> 0 == 1 # Common C behavior.
45
46 # And the same for <<, while Perl now produces 0 for both.
47
48Now these behaviors are well-defined under Perl, regardless of what
49the underlying C implementation does. Note, however, that you cannot
50escape the native integer width. If you need more bits on the left shift,
51you could use the C<bigint> pragma.
52
7d380357
RS
53=head2 Postfix dereferencing is no longer experimental
54
1c2511e0
AC
55Using the C<postderef> and C<postderef_qq> features no longer emits a
56warning. Existing code that disables the C<experimental::postderef> warning
57category that they previously used will continue to work. The C<postderef>
58feature has no effect; all Perl code can use postfix dereferencing,
59regardless of what feature declarations are in scope. The C<5.24> feature
60bundle now includes the C<postderef_qq> feature.
7d380357 61
fc4c3cec 62=head1 Security
2ad792cd 63
fc4c3cec
RS
64XXX Any security-related notices go here. In particular, any security
65vulnerabilities closed should be noted here rather than in the
66L</Selected Bug Fixes> section.
67
68[ List each security issue as a =head2 entry ]
2ad792cd 69
2cfe9b50 70=head1 Incompatible Changes
eabfc7bc 71
ce4793f1
KW
72=head2 ASCII characters in variable names must now be all visible
73
74It was legal until now on ASCII platforms for variable names to contain
75non-graphical ASCII control characters (ordinals 0 through 31, and 127,
76which are the C0 controls and C<DELETE>). This usage has been
77deprecated since v5.20, and as of now causes a syntax error. The
78variables these names referred to are special, reserved by Perl for
79whatever use it may choose, now, or in the future. Each such variable
80has an alternative way of spelling it. Instead of the single
81non-graphic control character, a two character sequence beginning with a
82caret is used, like C<$^]> and C<${^GLOBAL_PHASE}>. Details are at
83L<perlvar>. It remains legal, though unwise and deprecated (raising a
84deprecation warning), to use certain non-graphic non-ASCII characters in
85variables names when not under S<C<use utf8>>. No code should do this,
86as all such variables are reserved by Perl, and Perl doesn't currently
87define any of them (but could at any time, without notice).
eabfc7bc 88
26230909
AC
89=head2 The C<autoderef> feature has been removed
90
91The experimental C<autoderef> feature (which allowed calling C<push>,
92C<pop>, C<shift>, C<unshift>, C<splice>, C<keys>, C<values>, and C<each> on
93a scalar argument) has been deemed unsuccessful. It has now been removed;
94trying to use the feature (or to disable the C<experimental::autoderef>
95warning it previously triggered) now yields an exception.
96
fc4c3cec 97=head1 Deprecations
eabfc7bc 98
fc4c3cec 99XXX Any deprecated features, syntax, modules etc. should be listed here.
eabfc7bc 100
fc4c3cec
RS
101=head2 Module removals
102
103XXX Remove this section if inapplicable.
104
105The following modules will be removed from the core distribution in a
106future release, and will at that time need to be installed from CPAN.
107Distributions on CPAN which require these modules will need to list them as
108prerequisites.
109
110The core versions of these modules will now issue C<"deprecated">-category
111warnings to alert you to this fact. To silence these deprecation warnings,
112install the modules in question from CPAN.
113
114Note that these are (with rare exceptions) fine modules that you are encouraged
115to continue to use. Their disinclusion from core primarily hinges on their
116necessity to bootstrapping a fully functional, CPAN-capable Perl installation,
117not usually on concerns over their design.
118
119=over
120
121=item XXX
122
123XXX Note that deprecated modules should be listed here even if they are listed
124as an updated module in the L</Modules and Pragmata> section.
125
126=back
127
128[ List each other deprecation as a =head2 entry ]
129
130=head1 Performance Enhancements
131
132XXX Changes which enhance performance without changing behaviour go here.
133There may well be none in a stable release.
134
135[ List each enhancement as a =item entry ]
eabfc7bc 136
73d6481e 137=over 4
eabfc7bc 138
73d6481e 139=item *
eabfc7bc 140
fc4c3cec 141XXX
eabfc7bc 142
fc4c3cec 143=back
eabfc7bc 144
fc4c3cec 145=head1 Modules and Pragmata
eabfc7bc 146
fc4c3cec
RS
147XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
148go here. If Module::CoreList is updated, generate an initial draft of the
149following sections using F<Porting/corelist-perldelta.pl>. A paragraph summary
150for important changes should then be added by hand. In an ideal world,
151dual-life modules would have a F<Changes> file that could be cribbed.
eabfc7bc 152
fc4c3cec 153[ Within each section, list entries as a =item entry ]
eabfc7bc 154
fc4c3cec 155=head2 New Modules and Pragmata
eabfc7bc 156
fc4c3cec 157=over 4
eabfc7bc 158
73d6481e 159=item *
eabfc7bc 160
fc4c3cec 161XXX
eabfc7bc 162
fc4c3cec 163=back
eabfc7bc 164
fc4c3cec
RS
165=head2 Updated Modules and Pragmata
166
167=over 4
eabfc7bc
RS
168
169=item *
170
dc013420
SH
171L<autodie> has been upgraded from version 2.28 to 2.29.
172
173=item *
174
c85f23b2
DD
175L<IPC::Open3> has been upgraded from version 1.18 to 1.19.
176
177If a Perl exception was thrown from inside this module, the exception
779c45ce 178C<IPC::Open3> threw to the callers of C<open3> would have an irrelevant
c85f23b2
DD
179message derived from C<$!> which was in an undefined state, instead of the
180C<$@> message which triggers the failure path inside C<open3>.
eabfc7bc 181
6962a25d
SH
182=item *
183
184L<Unicode::Collate> has been upgraded from version 1.12 to 1.14.
185
fc4c3cec
RS
186=back
187
188=head2 Removed Modules and Pragmata
eabfc7bc 189
fc4c3cec 190=over 4
374c951f
SH
191
192=item *
193
fc4c3cec 194XXX
e586de20 195
fc4c3cec 196=back
e586de20 197
fc4c3cec 198=head1 Documentation
fd0a842f 199
fc4c3cec
RS
200XXX Changes to files in F<pod/> go here. Consider grouping entries by
201file and be sure to link to the appropriate page, e.g. L<perlfunc>.
fd0a842f 202
fc4c3cec 203=head2 New Documentation
99527ef1 204
fc4c3cec 205XXX Changes which create B<new> files in F<pod/> go here.
99527ef1 206
fc4c3cec 207=head3 L<XXX>
a4f8ff46 208
fc4c3cec 209XXX Description of the purpose of the new file here
a4f8ff46 210
fc4c3cec 211=head2 Changes to Existing Documentation
73d6481e 212
fc4c3cec
RS
213XXX Changes which significantly change existing files in F<pod/> go here.
214However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
215section.
216
217=head3 L<XXX>
73d6481e 218
fc4c3cec 219=over 4
eabfc7bc
RS
220
221=item *
222
fc4c3cec 223XXX Description of the change here
b7b593d8 224
fc4c3cec 225=back
b7b593d8 226
fc4c3cec 227=head1 Diagnostics
b7b593d8 228
fc4c3cec
RS
229The following additions or changes have been made to diagnostic output,
230including warnings and fatal error messages. For the complete list of
231diagnostic messages, see L<perldiag>.
b7b593d8 232
fc4c3cec
RS
233XXX New or changed warnings emitted by the core's C<C> code go here. Also
234include any changes in L<perldiag> that reconcile it to the C<C> code.
b7b593d8 235
fc4c3cec 236=head2 New Diagnostics
b7b593d8 237
fc4c3cec
RS
238XXX Newly added diagnostic messages go under here, separated into New Errors
239and New Warnings
b7b593d8 240
fc4c3cec
RS
241=head3 New Errors
242
243=over 4
eabfc7bc 244
ef5cf9f5
TC
245=item *
246
fc4c3cec 247XXX L<message|perldiag/"message">
72b8c7a2 248
fc4c3cec 249=back
72b8c7a2 250
fc4c3cec
RS
251=head3 New Warnings
252
253=over 4
bdb6acef
SH
254
255=item *
256
fc4c3cec 257XXX L<message|perldiag/"message">
ef5cf9f5 258
fc4c3cec 259=back
3d58dd24 260
fc4c3cec
RS
261=head2 Changes to Existing Diagnostics
262
263XXX Changes (i.e. rewording) of diagnostic messages go here
264
265=over 4
4b951711
TC
266
267=item *
268
fc4c3cec 269XXX Describe change here
eabfc7bc 270
fc4c3cec 271=back
eabfc7bc 272
fc4c3cec 273=head1 Utility Changes
eabfc7bc 274
fc4c3cec
RS
275XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here.
276Most of these are built within the directory F<utils>.
eabfc7bc 277
fc4c3cec
RS
278[ List utility changes as a =head2 entry for each utility and =item
279entries for each change
280Use L<XXX> with program names to get proper documentation linking. ]
eabfc7bc 281
fc4c3cec
RS
282=head2 L<XXX>
283
284=over 4
eabfc7bc
RS
285
286=item *
287
fc4c3cec 288XXX
eabfc7bc 289
fc4c3cec 290=back
eabfc7bc 291
fc4c3cec 292=head1 Configuration and Compilation
eabfc7bc 293
fc4c3cec
RS
294XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
295go here. Any other changes to the Perl build process should be listed here.
296However, any platform-specific changes should be listed in the
297L</Platform Support> section, instead.
eabfc7bc 298
fc4c3cec 299[ List changes as a =item entry ].
eabfc7bc 300
fc4c3cec 301=over 4
eabfc7bc
RS
302
303=item *
304
fc4c3cec 305XXX
eabfc7bc 306
fc4c3cec 307=back
eabfc7bc 308
fc4c3cec 309=head1 Testing
eabfc7bc 310
fc4c3cec
RS
311XXX Any significant changes to the testing of a freshly built perl should be
312listed here. Changes which create B<new> files in F<t/> go here as do any
313large changes to the testing harness (e.g. when parallel testing was added).
314Changes to existing files in F<t/> aren't worth summarizing, although the bugs
315that they represent may be covered elsewhere.
316
317[ List each test improvement as a =item entry ]
318
319=over 4
eabfc7bc 320
fc4c3cec 321=item *
eabfc7bc 322
fc4c3cec 323XXX
eabfc7bc 324
2cfe9b50 325=back
33ca8d3c 326
73d6481e 327=head1 Platform Support
eabfc7bc 328
fc4c3cec 329XXX Any changes to platform support should be listed in the sections below.
eabfc7bc 330
fc4c3cec
RS
331[ Within the sections, list each platform as a =item entry with specific
332changes as paragraphs below it. ]
eabfc7bc 333
fc4c3cec 334=head2 New Platforms
42fe7840 335
fc4c3cec
RS
336XXX List any platforms that this version of perl compiles on, that previous
337versions did not. These will either be enabled by new files in the F<hints/>
338directories, or new subdirectories and F<README> files at the top level of the
339source tree.
340
341=over 4
42fe7840 342
fc4c3cec
RS
343=item XXX-some-platform
344
345XXX
42fe7840
CB
346
347=back
348
fc4c3cec 349=head2 Discontinued Platforms
eabfc7bc 350
fc4c3cec 351XXX List any platforms that this version of perl no longer compiles on.
269713a1 352
fc4c3cec 353=over 4
269713a1 354
fc4c3cec 355=item XXX-some-platform
269713a1 356
fc4c3cec 357XXX
463e63a4 358
fc4c3cec 359=back
463e63a4 360
fc4c3cec 361=head2 Platform-Specific Notes
9c0328ac 362
fc4c3cec
RS
363XXX List any changes for specific platforms. This could include configuration
364and compilation changes or changes in portability/compatibility. However,
365changes within modules for platforms should generally be listed in the
366L</Modules and Pragmata> section.
9c0328ac 367
fc4c3cec
RS
368=over 4
369
7d380357 370=item VMS
fc4c3cec 371
7d380357
RS
372=over
373
374=item *
375
376The minimum supported version of VMS is now v7.3-2, released in 2003. As a
377side effect of this change, VAX is no longer supported as the terminal
378release of OpenVMS VAX was v7.3 in 2001.
379
380=back
eabfc7bc 381
2cfe9b50 382=back
eabfc7bc 383
fc4c3cec
RS
384=head1 Internal Changes
385
386XXX Changes which affect the interface available to C<XS> code go here. Other
387significant internal changes for future core maintainers should be noted as
388well.
389
390[ List each change as a =item entry ]
eabfc7bc 391
2cfe9b50 392=over 4
eabfc7bc
RS
393
394=item *
395
fc4c3cec 396XXX
eabfc7bc 397
fc4c3cec 398=back
302ef3d4 399
fc4c3cec 400=head1 Selected Bug Fixes
302ef3d4 401
fc4c3cec
RS
402XXX Important bug fixes in the core language are summarized here. Bug fixes in
403files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>.
eabfc7bc 404
fc4c3cec
RS
405[ List each fix as a =item entry ]
406
407=over 4
eabfc7bc 408
73d6481e 409=item *
eabfc7bc 410
7ed1d857
DD
411A leak in the XS typemap caused one scalar to be leaked each time a C<FILE *>
412or a C<PerlIO *> was C<OUTPUT:>ed or imported to Perl, since perl 5.000. These
413particular typemap entries are thought to be extremely rarely used by XS
414modules. [perl #124181]
eabfc7bc 415
fc4c3cec
RS
416=back
417
418=head1 Known Problems
419
420XXX Descriptions of platform agnostic bugs we know we can't fix go here. Any
421tests that had to be C<TODO>ed for the release would be noted here. Unfixed
422platform specific bugs also go here.
423
424[ List each fix as a =item entry ]
eabfc7bc 425
fc4c3cec
RS
426=over 4
427
428=item *
eabfc7bc 429
fc4c3cec 430XXX
eabfc7bc 431
73d6481e 432=back
eabfc7bc 433
fc4c3cec 434=head1 Errata From Previous Releases
eabfc7bc 435
fc4c3cec 436=over 4
eabfc7bc 437
fc4c3cec 438=item *
2a7a05b4 439
fc4c3cec
RS
440XXX Add anything here that we forgot to add, or were mistaken about, in
441the perldelta of a previous release.
30aa8e3f 442
fc4c3cec 443=back
30aa8e3f 444
fc4c3cec
RS
445=head1 Obituary
446
447XXX If any significant core contributor has died, we've added a short obituary
448here.
449
450=head1 Acknowledgements
2a7a05b4 451
fc4c3cec 452XXX Generate this with:
2cfe9b50 453
fc4c3cec 454 perl Porting/acknowledgements.pl v5.23.1..HEAD
f5b73711 455
44691e6f
AB
456=head1 Reporting Bugs
457
e08634c5
SH
458If you find what you think is a bug, you might check the articles recently
459posted to the comp.lang.perl.misc newsgroup and the perl bug database at
fc4c3cec
RS
460L<https://rt.perl.org/> . There may also be information at
461L<http://www.perl.org/> , the Perl Home Page.
44691e6f 462
e08634c5
SH
463If you believe you have an unreported bug, please run the L<perlbug> program
464included with your release. Be sure to trim your bug down to a tiny but
465sufficient test case. Your bug report, along with the output of C<perl -V>,
466will be sent off to perlbug@perl.org to be analysed by the Perl porting team.
44691e6f
AB
467
468If the bug you are reporting has security implications, which make it
e08634c5
SH
469inappropriate to send to a publicly archived mailing list, then please send it
470to perl5-security-report@perl.org. This points to a closed subscription
471unarchived mailing list, which includes all the core committers, who will be
472able to help assess the impact of issues, figure out a resolution, and help
f9001595 473co-ordinate the release of patches to mitigate or fix the problem across all
e08634c5
SH
474platforms on which Perl is supported. Please only use this address for
475security issues in the Perl core, not for modules independently distributed on
476CPAN.
44691e6f
AB
477
478=head1 SEE ALSO
479
e08634c5
SH
480The F<Changes> file for an explanation of how to view exhaustive details on
481what changed.
44691e6f
AB
482
483The F<INSTALL> file for how to build Perl.
484
485The F<README> file for general stuff.
486
487The F<Artistic> and F<Copying> files for copyright information.
488
489=cut