This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Update perldelta
[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.35.1
9
10 =head1 DESCRIPTION
11
12 This document describes differences between the 5.35.0 release and the 5.35.1
13 release.
14
15 If you are upgrading from an earlier release such as 5.34.0, first read
16 L<perl5350delta>, which describes differences between 5.34.0 and 5.35.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 =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<File::Copy> has been upgraded from version 2.35 to 2.36.
129
130 Inode numbers are now compared as strings, so that large inode numbers
131 are correctly distinguished. (GH #18788)
132
133 =item *
134
135 L<IO> has been upgraded from version 1.46 to 1.47.
136
137 Implement sync() for win32.
138
139 =item *
140
141 L<PathTools|Cwd> has been upgraded from version 3.80 to 3.81.
142
143 Inodes numbers are now compared as strings, so that large inode numbers
144 are correctly distinguished. (GH #18788)
145
146 =item *
147
148 L<Unicode::Collate> has been upgraded from version 1.29 to 1.30.
149
150 One warning in F<mkheader> averted (rt.cpan.org #133952).
151
152 =back
153
154 =head2 Removed Modules and Pragmata
155
156 =over 4
157
158 =item *
159
160 XXX
161
162 =back
163
164 =head1 Documentation
165
166 XXX Changes to files in F<pod/> go here.  Consider grouping entries by
167 file and be sure to link to the appropriate page, e.g. L<perlfunc>.
168
169 =head2 New Documentation
170
171 XXX Changes which create B<new> files in F<pod/> go here.
172
173 =head3 L<XXX>
174
175 XXX Description of the purpose of the new file here
176
177 =head2 Changes to Existing Documentation
178
179 We have attempted to update the documentation to reflect the changes
180 listed in this document.  If you find any we have missed, open an issue
181 at L<https://github.com/Perl/perl5/issues>.
182
183 XXX Changes which significantly change existing files in F<pod/> go here.
184 However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
185 section.
186
187 Additionally, the following selected changes have been made:
188
189 =head3 L<XXX>
190
191 =over 4
192
193 =item *
194
195 The C<Unicode::Unihan> CPAN module doesn't work on recent Unicode
196 versions, so references to it have been removed.
197
198 =back
199
200 =head1 Diagnostics
201
202 The following additions or changes have been made to diagnostic output,
203 including warnings and fatal error messages.  For the complete list of
204 diagnostic messages, see L<perldiag>.
205
206 XXX New or changed warnings emitted by the core's C<C> code go here.  Also
207 include any changes in L<perldiag> that reconcile it to the C<C> code.
208
209 =head2 New Diagnostics
210
211 XXX Newly added diagnostic messages go under here, separated into New Errors
212 and New Warnings
213
214 =head3 New Errors
215
216 =over 4
217
218 =item *
219
220 XXX L<message|perldiag/"message">
221
222 =back
223
224 =head3 New Warnings
225
226 =over 4
227
228 =item *
229
230 XXX L<message|perldiag/"message">
231
232 =back
233
234 =head2 Changes to Existing Diagnostics
235
236 XXX Changes (i.e. rewording) of diagnostic messages go here
237
238 =over 4
239
240 =item *
241
242 L<Can't modify %s in %s|perldiag/"Can't modify %s in %s">
243 (for scalar assignment to C<undef>)
244
245 Attempting to perform a scalar assignment to C<undef>, for example via
246 C<undef = $foo;>, previously triggered a fatal runtime error with the
247 message "L<Modification of a read-only value attempted|perldiag/"Modification of a read-only value attempted">."
248 It is more helpful to detect such attempted assignments prior to
249 runtime, so they are now compile time errors, resulting in the message
250 "Can't modify undef operator in scalar assignment".
251
252 =item *
253
254 XXX Describe change here
255
256 =back
257
258 =head1 Utility Changes
259
260 XXX Changes to installed programs such as F<perldoc> and F<xsubpp> go here.
261 Most of these are built within the directory F<utils>.
262
263 [ List utility changes as a =head2 entry for each utility and =item
264 entries for each change
265 Use L<XXX> with program names to get proper documentation linking. ]
266
267 =head2 L<XXX>
268
269 =over 4
270
271 =item *
272
273 XXX
274
275 =back
276
277 =head1 Configuration and Compilation
278
279 XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
280 go here.  Any other changes to the Perl build process should be listed here.
281 However, any platform-specific changes should be listed in the
282 L</Platform Support> section, instead.
283
284 [ List changes as an =item entry ].
285
286 =over 4
287
288 =item *
289
290 XXX
291
292 =back
293
294 =head1 Testing
295
296 XXX Any significant changes to the testing of a freshly built perl should be
297 listed here.  Changes which create B<new> files in F<t/> go here as do any
298 large changes to the testing harness (e.g. when parallel testing was added).
299 Changes to existing files in F<t/> aren't worth summarizing, although the bugs
300 that they represent may be covered elsewhere.
301
302 XXX If there were no significant test changes, say this:
303
304 Tests were added and changed to reflect the other additions and changes
305 in this release.
306
307 XXX If instead there were significant changes, say this:
308
309 Tests were added and changed to reflect the other additions and
310 changes in this release.  Furthermore, these significant changes were
311 made:
312
313 [ List each test improvement as an =item entry ]
314
315 =over 4
316
317 =item *
318
319 XXX
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 =over 4
375
376 =item *
377
378 Since the removal of PERL_OBJECT in Perl 5.8, PERL_IMPLICIT_CONTEXT and
379 MULTIPLICITY have been synonymous and they were being used interchangeably.
380 To simplify the code, all instances of PERL_IMPLICIT_CONTEXT have been
381 replaced with MULTIPLICITY.
382
383 PERL_IMPLICIT_CONTEXT will remain defined for compatibility with XS modules.
384
385 =item *
386
387 The definition for the C<ASSUME()> macro, broken on Windows in 5.34, has
388 been fixed.
389
390 =back
391
392 =head1 Selected Bug Fixes
393
394 XXX Important bug fixes in the core language are summarized here.  Bug fixes in
395 files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>.
396
397 [ List each fix as an =item entry ]
398
399 =over 4
400
401 =item *
402
403 utime() now correctly sets errno/C<$!> when called on a closed handle.
404
405 =item *
406
407 B::Deparse now correctly handles try/catch blocks with more complex scopes.
408 [L<GH #18874|https://github.com/Perl/perl5/issues/18874>]
409
410 =back
411
412 =head1 Known Problems
413
414 XXX Descriptions of platform agnostic bugs we know we can't fix go here.  Any
415 tests that had to be C<TODO>ed for the release would be noted here.  Unfixed
416 platform specific bugs also go here.
417
418 [ List each fix as an =item entry ]
419
420 =over 4
421
422 =item *
423
424 XXX
425
426 =back
427
428 =head1 Errata From Previous Releases
429
430 =over 4
431
432 =item *
433
434 XXX Add anything here that we forgot to add, or were mistaken about, in
435 the perldelta of a previous release.
436
437 =back
438
439 =head1 Obituary
440
441 Raun "Spider" Boardman (SPIDB on CPAN), author of at least 66 commits to the
442 Perl 5 core distribution between 1996 and 2002, passed away May 24 2021 from
443 complications of COVID.  He will be missed.
444
445 =head1 Acknowledgements
446
447 XXX Generate this with:
448
449   perl Porting/acknowledgements.pl v5.35.0..HEAD
450
451 =head1 Reporting Bugs
452
453 If you find what you think is a bug, you might check the perl bug database
454 at L<https://github.com/Perl/perl5/issues>.  There may also be information at
455 L<http://www.perl.org/>, the Perl Home Page.
456
457 If you believe you have an unreported bug, please open an issue at
458 L<https://github.com/Perl/perl5/issues>.  Be sure to trim your bug down to a
459 tiny but sufficient test case.
460
461 If the bug you are reporting has security implications which make it
462 inappropriate to send to a public issue tracker, then see
463 L<perlsec/SECURITY VULNERABILITY CONTACT INFORMATION>
464 for details of how to report the issue.
465
466 =head1 Give Thanks
467
468 If you wish to thank the Perl 5 Porters for the work we had done in Perl 5,
469 you can do so by running the C<perlthanks> program:
470
471     perlthanks
472
473 This will send an email to the Perl 5 Porters list with your show of thanks.
474
475 =head1 SEE ALSO
476
477 The F<Changes> file for an explanation of how to view exhaustive details on
478 what changed.
479
480 The F<INSTALL> file for how to build Perl.
481
482 The F<README> file for general stuff.
483
484 The F<Artistic> and F<Copying> files for copyright information.
485
486 =cut