This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Evaluate arg once in all forms of SvTRUE
[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.33.5
9
10 =head1 DESCRIPTION
11
12 This document describes differences between the 5.33.4 release and the 5.33.5
13 release.
14
15 If you are upgrading from an earlier release such as 5.33.3, first read
16 L<perl5334delta>, which describes differences between 5.33.3 and 5.33.4.
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 =head1 Security
31
32 XXX Any security-related notices go here.  In particular, any security
33 vulnerabilities closed should be noted here rather than in the
34 L</Selected Bug Fixes> section.
35
36 [ List each security issue as a =head2 entry ]
37
38 =head1 Incompatible Changes
39
40 XXX For a release on a stable branch, this section aspires to be:
41
42     There are no changes intentionally incompatible with 5.XXX.XXX
43     If any exist, they are bugs, and we request that you submit a
44     report.  See L</Reporting Bugs> below.
45
46 [ List each incompatible change as a =head2 entry ]
47
48 =head1 Deprecations
49
50 XXX Any deprecated features, syntax, modules etc. should be listed here.
51
52 =head2 Module removals
53
54 XXX Remove this section if not applicable.
55
56 The following modules will be removed from the core distribution in a
57 future release, and will at that time need to be installed from CPAN.
58 Distributions on CPAN which require these modules will need to list them as
59 prerequisites.
60
61 The core versions of these modules will now issue C<"deprecated">-category
62 warnings to alert you to this fact.  To silence these deprecation warnings,
63 install the modules in question from CPAN.
64
65 Note that these are (with rare exceptions) fine modules that you are encouraged
66 to continue to use.  Their disinclusion from core primarily hinges on their
67 necessity to bootstrapping a fully functional, CPAN-capable Perl installation,
68 not usually on concerns over their design.
69
70 =over
71
72 =item XXX
73
74 XXX Note that deprecated modules should be listed here even if they are listed
75 as an updated module in the L</Modules and Pragmata> section.
76
77 =back
78
79 [ List each other deprecation as a =head2 entry ]
80
81 =head1 Performance Enhancements
82
83 XXX Changes which enhance performance without changing behaviour go here.
84 There may well be none in a stable release.
85
86 [ List each enhancement as an =item entry ]
87
88 =over 4
89
90 =item *
91
92 XXX
93
94 =back
95
96 =head1 Modules and Pragmata
97
98 XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
99 go here.  If Module::CoreList is updated, generate an initial draft of the
100 following sections using F<Porting/corelist-perldelta.pl>.  A paragraph summary
101 for important changes should then be added by hand.  In an ideal world,
102 dual-life modules would have a F<Changes> file that could be cribbed.
103
104 The list of new and updated modules is modified automatically as part of
105 preparing a Perl release, so the only reason to manually add entries here is if
106 you're summarising the important changes in the module update. (Also, if the
107 manually-added details don't match the automatically-generated ones, the
108 release manager will have to investigate the situation carefully.)
109
110 [ Within each section, list entries as an =item entry ]
111
112 =head2 New Modules and Pragmata
113
114 =over 4
115
116 =item *
117
118 XXX Remove this section if not applicable.
119
120 =back
121
122 =head2 Updated Modules and Pragmata
123
124 =over 4
125
126 =item *
127
128 L<XXX> has been upgraded from version A.xx to B.yy.
129
130 If there was something important to note about this change, include that here.
131
132 =back
133
134 =head2 Removed Modules and Pragmata
135
136 =over 4
137
138 =item *
139
140 XXX
141
142 =back
143
144 =head1 Documentation
145
146 XXX Changes to files in F<pod/> go here.  Consider grouping entries by
147 file and be sure to link to the appropriate page, e.g. L<perlfunc>.
148
149 =head2 New Documentation
150
151 XXX Changes which create B<new> files in F<pod/> go here.
152
153 =head3 L<XXX>
154
155 XXX Description of the purpose of the new file here
156
157 =head2 Changes to Existing Documentation
158
159 We have attempted to update the documentation to reflect the changes
160 listed in this document.  If you find any we have missed, open an issue
161 at L<https://github.com/Perl/perl5/issues>.
162
163 XXX Changes which significantly change existing files in F<pod/> go here.
164 However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
165 section.
166
167 Additionally, the following selected changes have been made:
168
169 =head3 L<perlfunc>
170
171 =over 4
172
173 =item *
174
175 L<msgsnd()|perlfunc/msgsnd> documented a length field included in the
176 packed C<MSG> parameter to msgsnd(), but there was no such field.
177 C<MSG> contains only the type and the message content.
178
179 =back
180
181 =head1 Diagnostics
182
183 The following additions or changes have been made to diagnostic output,
184 including warnings and fatal error messages.  For the complete list of
185 diagnostic messages, see L<perldiag>.
186
187 XXX New or changed warnings emitted by the core's C<C> code go here.  Also
188 include any changes in L<perldiag> that reconcile it to the C<C> code.
189
190 =head2 New Diagnostics
191
192 XXX Newly added diagnostic messages go under here, separated into New Errors
193 and New Warnings
194
195 =head3 New Errors
196
197 =over 4
198
199 =item *
200
201 XXX L<message|perldiag/"message">
202
203 =back
204
205 =head3 New Warnings
206
207 =over 4
208
209 =item *
210
211 XXX L<message|perldiag/"message">
212
213 =back
214
215 =head2 Changes to Existing Diagnostics
216
217 XXX Changes (i.e. rewording) of diagnostic messages go here
218
219 =over 4
220
221 =item *
222
223 XXX Describe change here
224
225 =back
226
227 =head1 Utility Changes
228
229 XXX Changes to installed programs such as F<perldoc> and F<xsubpp> go here.
230 Most of these are built within the directory F<utils>.
231
232 [ List utility changes as a =head2 entry for each utility and =item
233 entries for each change
234 Use L<XXX> with program names to get proper documentation linking. ]
235
236 =head2 L<XXX>
237
238 =over 4
239
240 =item *
241
242 XXX
243
244 =back
245
246 =head1 Configuration and Compilation
247
248 XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
249 go here.  Any other changes to the Perl build process should be listed here.
250 However, any platform-specific changes should be listed in the
251 L</Platform Support> section, instead.
252
253 [ List changes as an =item entry ].
254
255 =over 4
256
257 =item *
258
259 XXX
260
261 =back
262
263 =head1 Testing
264
265 XXX Any significant changes to the testing of a freshly built perl should be
266 listed here.  Changes which create B<new> files in F<t/> go here as do any
267 large changes to the testing harness (e.g. when parallel testing was added).
268 Changes to existing files in F<t/> aren't worth summarizing, although the bugs
269 that they represent may be covered elsewhere.
270
271 XXX If there were no significant test changes, say this:
272
273 Tests were added and changed to reflect the other additions and changes
274 in this release.
275
276 XXX If instead there were significant changes, say this:
277
278 Tests were added and changed to reflect the other additions and
279 changes in this release.  Furthermore, these significant changes were
280 made:
281
282 [ List each test improvement as an =item entry ]
283
284 =over 4
285
286 =item *
287
288 When testing in parallel on many-core platforms, you can now cause the
289 test suite to finish somewhat earlier, but with less logical ordering of
290 the tests, by setting
291
292  PERL_TEST_HARNESS_ASAP=1
293
294 while running the test suite.
295
296 =back
297
298 =head1 Platform Support
299
300 XXX Any changes to platform support should be listed in the sections below.
301
302 [ Within the sections, list each platform as an =item entry with specific
303 changes as paragraphs below it. ]
304
305 =head2 New Platforms
306
307 XXX List any platforms that this version of perl compiles on, that previous
308 versions did not.  These will either be enabled by new files in the F<hints/>
309 directories, or new subdirectories and F<README> files at the top level of the
310 source tree.
311
312 =over 4
313
314 =item XXX-some-platform
315
316 XXX
317
318 =back
319
320 =head2 Discontinued Platforms
321
322 XXX List any platforms that this version of perl no longer compiles on.
323
324 =over 4
325
326 =item XXX-some-platform
327
328 XXX
329
330 =back
331
332 =head2 Platform-Specific Notes
333
334 XXX List any changes for specific platforms.  This could include configuration
335 and compilation changes or changes in portability/compatibility.  However,
336 changes within modules for platforms should generally be listed in the
337 L</Modules and Pragmata> section.
338
339 =over 4
340
341 =item Windows
342
343 Windows now supports L<symlink()|perlfunc/symlink> and
344 L<readlink()|perlfunc/readlink>, and L<lstat()|perlfunc/lstat> is no
345 longer an alias for L<stat()|perlfunc/stat>.
346 L<[#18005]|https://github.com/Perl/perl5/issues/18005>.
347
348 Unlike POSIX systems, creating a symbolic link on Windows requires
349 either elevated privileges or Windows 10 1703 or later with Developer
350 Mode enabled.
351
352 stat(), including C<stat FILEHANDLE>, and lstat() now uses our own
353 implementation that populates the device C<dev> and inode numbers
354 C<ino> returned rather than always returning zero.  The number of
355 links C<nlink> field is now always populated.
356
357 L<< C<${^WIN32_SLOPPY_STAT}> |perlvar/${^WIN32_SLOPPY_STAT} >> previously
358 controlled whether the C<nlink> field was populated requiring a
359 separate Windows API call to fetch, since nlink and the other
360 information required for stat() is now retrieved in a single API call.
361
362 The C<-r> and C<-w> operators now return true for the C<STDIN>,
363 C<STDOUT> and C<STDERR> handles.  Unfortunately it still won't return
364 true for duplicates of those handles.
365 L<[#8502]|https://github.com/Perl/perl5/issues/8502>.
366
367 The times returned by stat() and lstat() are no longer incorrect
368 across Daylight Savings Time adjustments.
369 L<[#6080]|https://github.com/Perl/perl5/issues/6080>.
370
371 C<-x> on a filehandle should now match C<-x> on the corresponding
372 filename on Vista or later.
373 L<[#4145]|https://github.com/Perl/perl5/issues/4145>.
374
375 C<-e '"'> no longer incorrectly returns true.
376 L<[#12431]|https://github.com/Perl/perl5/issues/12431>.
377
378 =back
379
380 =head1 Internal Changes
381
382 XXX Changes which affect the interface available to C<XS> code go here.  Other
383 significant internal changes for future core maintainers should be noted as
384 well.
385
386 [ List each change as an =item entry ]
387
388 =over 4
389
390 =item *
391
392 All C<SvTRUE>-ish functions now evaluate their arguments exactly once.
393 In 5.32, plain L<perlapi/C<SvTRUE>> was changed to do that; now the rest
394 do as well.
395
396 =back
397
398 =head1 Selected Bug Fixes
399
400 XXX Important bug fixes in the core language are summarized here.  Bug fixes in
401 files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>.
402
403 [ List each fix as an =item entry ]
404
405 =over 4
406
407 =item *
408
409 L<semctl()|perlfunc/semctl>, L<msgctl()|perlfunc/msgctl>, and
410 L<shmctl()|perlfunc/shmctl> now properly reset the UTF-8 flag on the
411 C<ARG> parameter if it's modified for C<IPC_STAT> or C<GETALL>
412 operations.
413
414 =item *
415
416 semctl(), msgctl(), and shmctl() now attempt to downgrade the C<ARG>
417 parameter if it's value is being used as input to C<IPC_SET> or
418 C<SETALL> calls.  A failed downgrade will thrown an exception.
419
420 =item *
421
422 In cases where semctl(), msgctl() or shmctl() would treat the C<ARG>
423 parameter as a pointer, an undefined value no longer generates a
424 warning.  In most such calls the pointer isn't used anyway and this
425 allows you to supply C<undef> for a value not used by the underlying
426 function.
427
428 =item *
429
430 L<semop()|perlfunc/semop> now downgrades the C<OPSTRING> parameter,
431 L<msgsnd()|perlfunc/msgsnd> now downgrades the C<MSG> parameter and
432 L<shmwrite|perlfunc/shmwrite> now downgrades the C<STRING> parameter
433 to treat them as bytes.  Previously they would be left upgraded,
434 providing a corrupted structure to the underlying function call.
435
436 =item *
437
438 L<msgrcv()|perlfunc/msgrcv> now properly resets the UTF-8 flag the
439 C<VAR> parameter when it is modified.  Previusly the UTF-8 flag could
440 be left on, resulting in a possibly corrupt result in C<VAR>.
441
442 =back
443
444 =head1 Known Problems
445
446 XXX Descriptions of platform agnostic bugs we know we can't fix go here.  Any
447 tests that had to be C<TODO>ed for the release would be noted here.  Unfixed
448 platform specific bugs also go here.
449
450 [ List each fix as an =item entry ]
451
452 =over 4
453
454 =item *
455
456 XXX
457
458 =back
459
460 =head1 Errata From Previous Releases
461
462 =over 4
463
464 =item *
465
466 XXX Add anything here that we forgot to add, or were mistaken about, in
467 the perldelta of a previous release.
468
469 =back
470
471 =head1 Obituary
472
473 XXX If any significant core contributor or member of the CPAN community has
474 died, add a short obituary here.
475
476 =head1 Acknowledgements
477
478 XXX Generate this with:
479
480   perl Porting/acknowledgements.pl v5.33.4..HEAD
481
482 =head1 Reporting Bugs
483
484 If you find what you think is a bug, you might check the perl bug database
485 at L<https://github.com/Perl/perl5/issues>.  There may also be information at
486 L<http://www.perl.org/>, the Perl Home Page.
487
488 If you believe you have an unreported bug, please open an issue at
489 L<https://github.com/Perl/perl5/issues>.  Be sure to trim your bug down to a
490 tiny but sufficient test case.
491
492 If the bug you are reporting has security implications which make it
493 inappropriate to send to a public issue tracker, then see
494 L<perlsec/SECURITY VULNERABILITY CONTACT INFORMATION>
495 for details of how to report the issue.
496
497 =head1 Give Thanks
498
499 If you wish to thank the Perl 5 Porters for the work we had done in Perl 5,
500 you can do so by running the C<perlthanks> program:
501
502     perlthanks
503
504 This will send an email to the Perl 5 Porters list with your show of thanks.
505
506 =head1 SEE ALSO
507
508 The F<Changes> file for an explanation of how to view exhaustive details on
509 what changed.
510
511 The F<INSTALL> file for how to build Perl.
512
513 The F<README> file for general stuff.
514
515 The F<Artistic> and F<Copying> files for copyright information.
516
517 =cut