This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
perldelta for 412d75ef55
[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.39.6
9
10 =head1 DESCRIPTION
11
12 This document describes differences between the 5.39.5 release and the 5.39.6
13 release.
14
15 If you are upgrading from an earlier release such as 5.39.4, first read
16 L<perl5395delta>, which describes differences between 5.39.4 and 5.39.5.
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 This release fixes the following security issues.
39
40 =head2 CVE-2023-47038 - Write past buffer end via illegal user-defined Unicode property
41
42 This vulnerability was reported directly to the Perl security team by
43 Nathan Mills C<the.true.nathan.mills@gmail.com>.
44
45 A crafted regular expression when compiled by perl 5.30.0 through
46 5.38.0 can cause a one-byte attacker controlled buffer overflow in a
47 heap allocated buffer.
48
49 =head2 CVE-2023-47039 - Perl for Windows binary hijacking vulnerability
50
51 This vulnerability was reported to the Intel Product Security Incident
52 Response Team (PSIRT) by GitHub user ycdxsb
53 L<https://github.com/ycdxsb/WindowsPrivilegeEscalation>. PSIRT then
54 reported it to the Perl security team.
55
56 Perl for Windows relies on the system path environment variable to
57 find the shell (C<cmd.exe>). When running an executable which uses
58 Windows Perl interpreter, Perl attempts to find and execute C<cmd.exe>
59 within the operating system. However, due to path search order issues,
60 Perl initially looks for cmd.exe in the current working directory.
61
62 An attacker with limited privileges can exploit this behavior by
63 placing C<cmd.exe> in locations with weak permissions, such as
64 C<C:\ProgramData>. By doing so, when an administrator attempts to use
65 this executable from these compromised locations, arbitrary code can
66 be executed.
67
68 =head1 Incompatible Changes
69
70 XXX For a release on a stable branch, this section aspires to be:
71
72     There are no changes intentionally incompatible with 5.XXX.XXX
73     If any exist, they are bugs, and we request that you submit a
74     report.  See L</Reporting Bugs> below.
75
76 [ List each incompatible change as a =head2 entry ]
77
78 =head1 Deprecations
79
80 XXX Any deprecated features, syntax, modules etc. should be listed here.
81
82 =head2 Module removals
83
84 XXX Remove this section if not applicable.
85
86 The following modules will be removed from the core distribution in a
87 future release, and will at that time need to be installed from CPAN.
88 Distributions on CPAN which require these modules will need to list them as
89 prerequisites.
90
91 The core versions of these modules will now issue C<"deprecated">-category
92 warnings to alert you to this fact.  To silence these deprecation warnings,
93 install the modules in question from CPAN.
94
95 Note that these are (with rare exceptions) fine modules that you are encouraged
96 to continue to use.  Their disinclusion from core primarily hinges on their
97 necessity to bootstrapping a fully functional, CPAN-capable Perl installation,
98 not usually on concerns over their design.
99
100 =over
101
102 =item XXX
103
104 XXX Note that deprecated modules should be listed here even if they are listed
105 as an updated module in the L</Modules and Pragmata> section.
106
107 =back
108
109 [ List each other deprecation as a =head2 entry ]
110
111 =head1 Performance Enhancements
112
113 XXX Changes which enhance performance without changing behaviour go here.
114 There may well be none in a stable release.
115
116 [ List each enhancement as an =item entry ]
117
118 =over 4
119
120 =item *
121
122 XXX
123
124 =back
125
126 =head1 Modules and Pragmata
127
128 XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
129 go here.  If Module::CoreList is updated, generate an initial draft of the
130 following sections using F<Porting/corelist-perldelta.pl>.  A paragraph summary
131 for important changes should then be added by hand.  In an ideal world,
132 dual-life modules would have a F<Changes> file that could be cribbed.
133
134 The list of new and updated modules is modified automatically as part of
135 preparing a Perl release, so the only reason to manually add entries here is if
136 you're summarising the important changes in the module update. (Also, if the
137 manually-added details don't match the automatically-generated ones, the
138 release manager will have to investigate the situation carefully.)
139
140 [ Within each section, list entries as an =item entry ]
141
142 =head2 New Modules and Pragmata
143
144 =over 4
145
146 =item *
147
148 XXX Remove this section if Porting/corelist-perldelta.pl did not add any content here.
149
150 =back
151
152 =head2 Updated Modules and Pragmata
153
154 =over 4
155
156 =item *
157
158 L<XXX> has been upgraded from version A.xx to B.yy.
159
160 XXX If there was something important to note about this change, include that here.
161
162 =back
163
164 =head2 Removed Modules and Pragmata
165
166 =over 4
167
168 =item *
169
170 XXX Remove this section if Porting/corelist-perldelta.pl did not add any content here.
171
172 =back
173
174 =head1 Documentation
175
176 XXX Changes to files in F<pod/> go here.  Consider grouping entries by
177 file and be sure to link to the appropriate page, e.g. L<perlfunc>.
178
179 =head2 New Documentation
180
181 XXX Changes which create B<new> files in F<pod/> go here.
182
183 =head3 L<XXX>
184
185 XXX Description of the purpose of the new file here
186
187 =head2 Changes to Existing Documentation
188
189 We have attempted to update the documentation to reflect the changes
190 listed in this document.  If you find any we have missed, open an issue
191 at L<https://github.com/Perl/perl5/issues>.
192
193 XXX Changes which significantly change existing files in F<pod/> go here.
194 However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
195 section.
196
197 Additionally, the following selected changes have been made:
198
199 =head3 L<XXX>
200
201 =over 4
202
203 =item *
204
205 XXX Description of the change here
206
207 =back
208
209 =head1 Diagnostics
210
211 The following additions or changes have been made to diagnostic output,
212 including warnings and fatal error messages.  For the complete list of
213 diagnostic messages, see L<perldiag>.
214
215 XXX New or changed warnings emitted by the core's C<C> code go here.  Also
216 include any changes in L<perldiag> that reconcile it to the C<C> code.
217
218 =head2 New Diagnostics
219
220 XXX Newly added diagnostic messages go under here, separated into New Errors
221 and New Warnings
222
223 =head3 New Errors
224
225 =over 4
226
227 =item *
228
229 XXX L<message|perldiag/"message">
230
231 =back
232
233 =head3 New Warnings
234
235 =over 4
236
237 =item *
238
239 XXX L<message|perldiag/"message">
240
241 =back
242
243 =head2 Changes to Existing Diagnostics
244
245 XXX Changes (i.e. rewording) of diagnostic messages go here
246
247 =over 4
248
249 =item *
250
251 XXX Describe change here
252
253 =back
254
255 =head1 Utility Changes
256
257 XXX Changes to installed programs such as F<perldoc> and F<xsubpp> go here.
258 Most of these are built within the directory F<utils>.
259
260 [ List utility changes as a =head2 entry for each utility and =item
261 entries for each change
262 Use L<XXX> with program names to get proper documentation linking. ]
263
264 =head2 L<XXX>
265
266 =over 4
267
268 =item *
269
270 XXX
271
272 =back
273
274 =head1 Configuration and Compilation
275
276 XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
277 go here.  Any other changes to the Perl build process should be listed here.
278 However, any platform-specific changes should be listed in the
279 L</Platform Support> section, instead.
280
281 [ List changes as an =item entry ].
282
283 =over 4
284
285 =item *
286
287 XXX
288
289 =back
290
291 =head1 Testing
292
293 XXX Any significant changes to the testing of a freshly built perl should be
294 listed here.  Changes which create B<new> files in F<t/> go here as do any
295 large changes to the testing harness (e.g. when parallel testing was added).
296 Changes to existing files in F<t/> aren't worth summarizing, although the bugs
297 that they represent may be covered elsewhere.
298
299 XXX If there were no significant test changes, say this:
300
301 Tests were added and changed to reflect the other additions and changes
302 in this release.
303
304 XXX If instead there were significant changes, say this:
305
306 Tests were added and changed to reflect the other additions and
307 changes in this release.  Furthermore, these significant changes were
308 made:
309
310 [ List each test improvement as an =item entry ]
311
312 =over 4
313
314 =item *
315
316 The test F<t/porting/libperl.t> will no longer run in maint releases.
317 This test is sensitive to changes in the output of F<nm> on various
318 platforms, and tarballs aren't updated as we update this test in
319 blead.  [GH #21677]
320
321 =back
322
323 =head1 Platform Support
324
325 XXX Any changes to platform support should be listed in the sections below.
326
327 [ Within the sections, list each platform as an =item entry with specific
328 changes as paragraphs below it. ]
329
330 =head2 New Platforms
331
332 XXX List any platforms that this version of perl compiles on, that previous
333 versions did not.  These will either be enabled by new files in the F<hints/>
334 directories, or new subdirectories and F<README> files at the top level of the
335 source tree.
336
337 =over 4
338
339 =item XXX-some-platform
340
341 XXX
342
343 =back
344
345 =head2 Discontinued Platforms
346
347 XXX List any platforms that this version of perl no longer compiles on.
348
349 =over 4
350
351 =item XXX-some-platform
352
353 XXX
354
355 =back
356
357 =head2 Platform-Specific Notes
358
359 XXX List any changes for specific platforms.  This could include configuration
360 and compilation changes or changes in portability/compatibility.  However,
361 changes within modules for platforms should generally be listed in the
362 L</Modules and Pragmata> section.
363
364 =over 4
365
366 =item XXX-some-platform
367
368 XXX
369
370 =back
371
372 =head1 Internal Changes
373
374 XXX Changes which affect the interface available to C<XS> code go here.  Other
375 significant internal changes for future core maintainers should be noted as
376 well.
377
378 [ List each change as an =item entry ]
379
380 =over 4
381
382 =item *
383
384 XXX
385
386 =back
387
388 =head1 Selected Bug Fixes
389
390 XXX Important bug fixes in the core language are summarized here.  Bug fixes in
391 files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>.
392
393 Include references to GitHub issues and PRs as: [GH #12345] and the release
394 manager will later use a regex to expand these into links.
395
396 [ List each fix as an =item entry ]
397
398 =over 4
399
400 =item *
401
402 The tmps (mortal) stack now grows exponentially.  Previously it grew
403 linearly, so if it was growing incrementally, such as through many
404 calls to sv_2mortal(), on a system where realloc() is O(size), the
405 performance would be O(n*n).  With exponential grows this changes to
406 amortized O(n).  [GH #21654]
407
408 =back
409
410 =head1 Known Problems
411
412 XXX Descriptions of platform agnostic bugs we know we can't fix go here.  Any
413 tests that had to be C<TODO>ed for the release would be noted here.  Unfixed
414 platform specific bugs also go here.
415
416 [ List each fix as an =item entry ]
417
418 =over 4
419
420 =item *
421
422 XXX
423
424 =back
425
426 =head1 Errata From Previous Releases
427
428 =over 4
429
430 =item *
431
432 XXX Add anything here that we forgot to add, or were mistaken about, in
433 the perldelta of a previous release.
434
435 =back
436
437 =head1 Obituary
438
439 XXX If any significant core contributor or member of the CPAN community has
440 died, add a short obituary here.
441
442 =head1 Acknowledgements
443
444 XXX Generate this with:
445
446   perl Porting/acknowledgements.pl v5.39.5..HEAD
447
448 =head1 Reporting Bugs
449
450 If you find what you think is a bug, you might check the perl bug database
451 at L<https://github.com/Perl/perl5/issues>.  There may also be information at
452 L<http://www.perl.org/>, the Perl Home Page.
453
454 If you believe you have an unreported bug, please open an issue at
455 L<https://github.com/Perl/perl5/issues>.  Be sure to trim your bug down to a
456 tiny but sufficient test case.
457
458 If the bug you are reporting has security implications which make it
459 inappropriate to send to a public issue tracker, then see
460 L<perlsec/SECURITY VULNERABILITY CONTACT INFORMATION>
461 for details of how to report the issue.
462
463 =head1 Give Thanks
464
465 If you wish to thank the Perl 5 Porters for the work we had done in Perl 5,
466 you can do so by running the C<perlthanks> program:
467
468     perlthanks
469
470 This will send an email to the Perl 5 Porters list with your show of thanks.
471
472 =head1 SEE ALSO
473
474 The F<Changes> file for an explanation of how to view exhaustive details on
475 what changed.
476
477 The F<INSTALL> file for how to build Perl.
478
479 The F<README> file for general stuff.
480
481 The F<Artistic> and F<Copying> files for copyright information.
482
483 =cut