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