This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
perldelta - Modules and Pragmata
[perl5.git] / pod / perldelta.pod
CommitLineData
44691e6f
AB
1=encoding utf8
2
3=head1 NAME
4
74c14c97
MM
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.31.5
d407e309 9
862f380b 10=head1 DESCRIPTION
261e14b0 11
74c14c97 12This document describes differences between the 5.31.4 release and the 5.31.5
862f380b 13release.
261e14b0 14
74c14c97
MM
15If you are upgrading from an earlier release such as 5.31.3, first read
16L<perl5314delta>, which describes differences between 5.31.3 and 5.31.4.
fcbec156
TH
17
18=head1 Notice
19
74c14c97 20XXX Any important notices here
fcbec156
TH
21
22=head1 Core Enhancements
23
74c14c97
MM
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.
27
28[ List each enhancement as a =head2 entry ]
29
30=head1 Security
fd41b2d1 31
74c14c97
MM
32XXX Any security-related notices go here. In particular, any security
33vulnerabilities closed should be noted here rather than in the
34L</Selected Bug Fixes> section.
35
36[ List each security issue as a =head2 entry ]
fd41b2d1 37
9064626f
SH
38=head1 Incompatible Changes
39
74c14c97
MM
40XXX For a release on a stable branch, this section aspires to be:
41
42 There are no changes intentionally incompatible with 5.XXX.XXX
fcbec156
TH
43 If any exist, they are bugs, and we request that you submit a
44 report. See L</Reporting Bugs> below.
e6132dc0 45
74c14c97
MM
46[ List each incompatible change as a =head2 entry ]
47
7fd0eed3
TC
48=head2 Modifiable variables are no longer permitted in constants
49
50Code like:
51
52 my $var;
53 $sub = sub () { $var };
54
55where C<$var> is referenced elsewhere in some sort of modiable context
56now produces an exception when the sub is defined.
57
58This error can be avoided by adding a return to the sub definition:
59
60 $sub = sub () { return $var };
61
62This has been deprecated since perl 5.22.
63
64[perl #131138]
65
fcbec156 66=head1 Deprecations
e6132dc0 67
74c14c97
MM
68XXX Any deprecated features, syntax, modules etc. should be listed here.
69
fcbec156 70=head2 Module removals
befef368 71
74c14c97 72XXX Remove this section if not applicable.
befef368 73
74c14c97
MM
74The following modules will be removed from the core distribution in a
75future release, and will at that time need to be installed from CPAN.
76Distributions on CPAN which require these modules will need to list them as
77prerequisites.
fcbec156 78
74c14c97
MM
79The core versions of these modules will now issue C<"deprecated">-category
80warnings to alert you to this fact. To silence these deprecation warnings,
81install the modules in question from CPAN.
fcbec156 82
74c14c97
MM
83Note that these are (with rare exceptions) fine modules that you are encouraged
84to continue to use. Their disinclusion from core primarily hinges on their
85necessity to bootstrapping a fully functional, CPAN-capable Perl installation,
86not usually on concerns over their design.
fcbec156 87
74c14c97 88=over
fcbec156 89
74c14c97 90=item XXX
fcbec156 91
74c14c97
MM
92XXX Note that deprecated modules should be listed here even if they are listed
93as an updated module in the L</Modules and Pragmata> section.
94
95=back
96
97[ List each other deprecation as a =head2 entry ]
98
99=head1 Performance Enhancements
100
101XXX Changes which enhance performance without changing behaviour go here.
102There may well be none in a stable release.
103
104[ List each enhancement as an =item entry ]
9064626f
SH
105
106=over 4
a0348300 107
9c600b76 108=item *
a0348300 109
74c14c97 110XXX
be2eb09e 111
74c14c97 112=back
fcbec156 113
74c14c97 114=head1 Modules and Pragmata
be2eb09e 115
ced2c819 116=head2 Updated Modules and Pragmata
03b7d279 117
74c14c97 118=over 4
03b7d279
TC
119
120=item *
121
ced2c819 122L<B> has been upgraded from version 1.76 to 1.77.
03b7d279 123
ced2c819 124=item *
74c14c97 125
ced2c819 126L<B::Deparse> has been upgraded from version 1.49 to 1.50.
36bb8f68
JK
127
128=item *
129
ced2c819 130L<Devel::PPPort> has been upgraded from version 3.55 to 3.54.
c8d86fdc 131
ced2c819
SH
132=item *
133
134L<Digest::MD5> has been upgraded from version 2.55 to 2.55_01.
74c14c97 135
eeef80ee
JK
136=item *
137
138L<Dumpvalue> has been upgraded from version 1.18 to 1.21.
139
140Previously, when dumping elements of an array and encountering an undefined
141value, the string printed would have been C<empty array>. This has been
142changed to what was apparently originally intended: C<empty slot>.
143
ced2c819 144=item *
c8d86fdc 145
ced2c819 146L<ExtUtils::CBuilder> has been upgraded from version 0.280232 to 0.280233.
74c14c97 147
ced2c819
SH
148=item *
149
150L<Math::BigInt> has been upgraded from version 1.999816 to 1.999817_01.
be2eb09e
TH
151
152=item *
153
ced2c819
SH
154L<Math::BigInt::FastCalc> has been upgraded from version 0.5008 to 0.5009.
155
156=item *
157
158L<Module::CoreList> has been upgraded from version 5.20190920 to 5.20191020.
159
160=item *
161
162L<Safe> has been upgraded from version 2.40 to 2.41.
163
164=item *
165
166L<threads> has been upgraded from version 2.22 to 2.23.
167
168=item *
169
170L<Time::HiRes> has been upgraded from version 1.9763 to 1.9764.
171
172=item *
173
174L<XS::APItest> has been upgraded from version 1.03 to 1.04.
175
176If there was something important to note about this change, include that here.
fcbec156
TH
177
178=back
179
74c14c97
MM
180=head1 Documentation
181
182XXX Changes to files in F<pod/> go here. Consider grouping entries by
183file and be sure to link to the appropriate page, e.g. L<perlfunc>.
fcbec156 184
74c14c97
MM
185=head2 New Documentation
186
187XXX Changes which create B<new> files in F<pod/> go here.
188
189=head3 L<XXX>
190
191XXX Description of the purpose of the new file here
fcbec156
TH
192
193=head2 Changes to Existing Documentation
194
195We have attempted to update the documentation to reflect the changes
196listed in this document. If you find any we have missed, send email
197to L<perlbug@perl.org|mailto:perlbug@perl.org>.
198
74c14c97
MM
199XXX Changes which significantly change existing files in F<pod/> go here.
200However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
201section.
202
fcbec156
TH
203Additionally, the following selected changes have been made:
204
04d3d25b
MM
205=head3 URLs have been changed to https://, stale links updated
206
207=over 4
208
209=item *
210
211Where applicable, the URLs in the documentation have been moved from
212using the http:// protocol to https:// . This also affects the location
213of the bug tracker at L<https://rt.perl.org>.
214
215=item *
216
217Some links to OS/2 libraries, Address Sanitizer and other system tools
218had gone stale. These have been updated with working links.
219
220=item *
221
222Some links to old mails on perl5-porters had gone stale. These have been
223updated with working links.
224
225=back
226
74c14c97 227=head3 L<XXX>
fcbec156
TH
228
229=over 4
be2eb09e
TH
230
231=item *
232
74c14c97 233XXX Description of the change here
fcbec156
TH
234
235=back
236
237=head1 Diagnostics
238
239The following additions or changes have been made to diagnostic output,
240including warnings and fatal error messages. For the complete list of
241diagnostic messages, see L<perldiag>.
242
74c14c97
MM
243XXX New or changed warnings emitted by the core's C<C> code go here. Also
244include any changes in L<perldiag> that reconcile it to the C<C> code.
245
fcbec156
TH
246=head2 New Diagnostics
247
74c14c97
MM
248XXX Newly added diagnostic messages go under here, separated into New Errors
249and New Warnings
250
251=head3 New Errors
252
253=over 4
254
255=item *
256
257XXX L<message|perldiag/"message">
258
259=back
260
261=head3 New Warnings
262
263=over 4
264
265=item *
266
267XXX L<message|perldiag/"message">
268
269=back
270
271=head2 Changes to Existing Diagnostics
272
273XXX Changes (i.e. rewording) of diagnostic messages go here
274
275=over 4
276
277=item *
278
279XXX Describe change here
280
281=back
282
283=head1 Utility Changes
284
285XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here.
286Most of these are built within the directory F<utils>.
287
288[ List utility changes as a =head2 entry for each utility and =item
289entries for each change
290Use L<XXX> with program names to get proper documentation linking. ]
291
292=head2 L<XXX>
293
294=over 4
295
296=item *
297
298XXX
299
300=back
fcbec156
TH
301
302=head1 Configuration and Compilation
303
74c14c97
MM
304XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
305go here. Any other changes to the Perl build process should be listed here.
306However, any platform-specific changes should be listed in the
307L</Platform Support> section, instead.
308
309[ List changes as an =item entry ].
310
fcbec156 311=over 4
f0f66070
TC
312
313=item *
314
a578d0f3
TC
315Perl now no longer probes for C<d_u32align>, defaulting to C<define>
316on all platforms. This check was error prone when it was done, which
317was on 32-bit platforms only. [perl #133495]
06bfb2b1 318
c5103e52
MB
319=item *
320
321Documentation and hints for building perl on Z/OS (native EBCDIC) have
322been updated. Still work in progress.
323
324=item *
325
326New probe for malloc_usable_size
327
fcbec156
TH
328=back
329
330=head1 Testing
331
74c14c97
MM
332XXX Any significant changes to the testing of a freshly built perl should be
333listed here. Changes which create B<new> files in F<t/> go here as do any
334large changes to the testing harness (e.g. when parallel testing was added).
335Changes to existing files in F<t/> aren't worth summarizing, although the bugs
336that they represent may be covered elsewhere.
337
338XXX If there were no significant test changes, say this:
339
fcbec156
TH
340Tests were added and changed to reflect the other additions and changes
341in this release.
342
74c14c97
MM
343XXX If instead there were significant changes, say this:
344
345Tests were added and changed to reflect the other additions and
346changes in this release. Furthermore, these significant changes were
347made:
348
349[ List each test improvement as an =item entry ]
350
351=over 4
352
353=item *
354
355XXX
356
357=back
358
dad02c36 359=head1 Platform Support
8424e368 360
74c14c97
MM
361XXX Any changes to platform support should be listed in the sections below.
362
363[ Within the sections, list each platform as an =item entry with specific
364changes as paragraphs below it. ]
365
366=head2 New Platforms
367
368XXX List any platforms that this version of perl compiles on, that previous
369versions did not. These will either be enabled by new files in the F<hints/>
370directories, or new subdirectories and F<README> files at the top level of the
371source tree.
372
373=over 4
374
375=item XXX-some-platform
376
377XXX
378
379=back
380
381=head2 Discontinued Platforms
382
383XXX List any platforms that this version of perl no longer compiles on.
fcbec156 384
fcbec156 385=over 4
061637ca 386
74c14c97
MM
387=item XXX-some-platform
388
389XXX
390
391=back
392
393=head2 Platform-Specific Notes
fcbec156 394
74c14c97
MM
395XXX List any changes for specific platforms. This could include configuration
396and compilation changes or changes in portability/compatibility. However,
397changes within modules for platforms should generally be listed in the
398L</Modules and Pragmata> section.
399
400=over 4
0076a047 401
2e1181e2 402=item Windows
74c14c97 403
2e1181e2 404Support for building perl with Visual C++ 6.0 has now been removed.
fcbec156
TH
405
406=back
407
408=head1 Internal Changes
409
74c14c97
MM
410XXX Changes which affect the interface available to C<XS> code go here. Other
411significant internal changes for future core maintainers should be noted as
412well.
413
414[ List each change as an =item entry ]
415
fcbec156 416=over 4
061637ca 417
285db695
DM
418=item *
419
5b6f7443
DM
420Added the C<<PL_curstackinfo->si_cxsubix>> field. This records the stack
421index of the most recently pushed sub/format/eval context. It is set and
422restored automatically by C<cx_pushsub()>, C<cx_popsub()> etc., but would
423need to be manually managed if you do any unusual manipulation of the
424context stack.
285db695 425
059703b0
KW
426=item *
427
428Various macros dealing with character type classification and changing
429case where the input is encoded in UTF-8 now require an extra parameter
430to prevent potential reads beyond the end of the buffer. Use of these
431has generated a deprecation warning since 5.26. Details are in
432L<perldeprecation/In XS code, use of various macros dealing with UTF-8.>
433
9064626f 434=back
ed0cf058 435
9064626f 436=head1 Selected Bug Fixes
ed0cf058 437
74c14c97
MM
438XXX Important bug fixes in the core language are summarized here. Bug fixes in
439files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>.
440
441[ List each fix as an =item entry ]
442
9064626f 443=over 4
973ae088 444
f7faf2ad
SH
445=item *
446
74c14c97 447XXX
f7faf2ad 448
74c14c97 449=back
8714ff4f 450
74c14c97
MM
451=head1 Known Problems
452
453XXX Descriptions of platform agnostic bugs we know we can't fix go here. Any
454tests that had to be C<TODO>ed for the release would be noted here. Unfixed
455platform specific bugs also go here.
456
457[ List each fix as an =item entry ]
458
459=over 4
8714ff4f 460
7118f704
TC
461=item *
462
74c14c97 463XXX
7118f704 464
fcbec156
TH
465=back
466
74c14c97 467=head1 Errata From Previous Releases
fcbec156 468
74c14c97 469=over 4
a3c77565 470
74c14c97 471=item *
fcbec156 472
74c14c97
MM
473XXX Add anything here that we forgot to add, or were mistaken about, in
474the perldelta of a previous release.
bd833cba 475
74c14c97 476=back
bd833cba 477
74c14c97 478=head1 Obituary
bd833cba 479
74c14c97
MM
480XXX If any significant core contributor or member of the CPAN community has
481died, add a short obituary here.
bd833cba 482
74c14c97 483=head1 Acknowledgements
bd833cba 484
74c14c97 485XXX Generate this with:
bd833cba 486
74c14c97 487 perl Porting/acknowledgements.pl v5.31.4..HEAD
8424e368 488
44691e6f
AB
489=head1 Reporting Bugs
490
9064626f
SH
491If you find what you think is a bug, you might check the perl bug database
492at L<https://rt.perl.org/>. There may also be information at
71c89d21 493L<https://www.perl.org/>, the Perl Home Page.
44691e6f 494
e08634c5
SH
495If you believe you have an unreported bug, please run the L<perlbug> program
496included with your release. Be sure to trim your bug down to a tiny but
497sufficient test case. Your bug report, along with the output of C<perl -V>,
0e18d1c4 498will be sent off to perlbug@perl.org to be analysed by the Perl porting team.
44691e6f 499
87c118b9
DM
500If the bug you are reporting has security implications which make it
501inappropriate to send to a publicly archived mailing list, then see
9064626f
SH
502L<perlsec/SECURITY VULNERABILITY CONTACT INFORMATION>
503for details of how to report the issue.
44691e6f 504
390ae6f9
S
505=head1 Give Thanks
506
9064626f
SH
507If you wish to thank the Perl 5 Porters for the work we had done in Perl 5,
508you can do so by running the C<perlthanks> program:
390ae6f9
S
509
510 perlthanks
511
512This will send an email to the Perl 5 Porters list with your show of thanks.
513
44691e6f
AB
514=head1 SEE ALSO
515
e08634c5
SH
516The F<Changes> file for an explanation of how to view exhaustive details on
517what changed.
44691e6f
AB
518
519The F<INSTALL> file for how to build Perl.
520
521The F<README> file for general stuff.
522
523The F<Artistic> and F<Copying> files for copyright information.
524
525=cut