This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Suppress spurious corelist-perldelta.pl warning
[perl5.git] / pod / perldelta.pod
CommitLineData
44691e6f
AB
1=encoding utf8
2
3=head1 NAME
4
a8ba758d
JSA
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.27.5
89853d76 9
b5cbfe35 10=head1 DESCRIPTION
89853d76 11
a8ba758d 12This document describes differences between the 5.27.4 release and the 5.27.5
b5cbfe35 13release.
89853d76 14
a8ba758d
JSA
15If you are upgrading from an earlier release such as 5.27.3, first read
16L<perl5274delta>, which describes differences between 5.27.3 and 5.27.4.
17
18=head1 Notice
19
20XXX Any important notices here
c83a3d01 21
c83a3d01
MH
22=head1 Core Enhancements
23
a8ba758d
JSA
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.
7bd9fb10 27
a8ba758d 28[ List each enhancement as a =head2 entry ]
7bd9fb10 29
a8ba758d 30=head1 Security
7bd9fb10 31
a8ba758d
JSA
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.
7bd9fb10 35
a8ba758d 36[ List each security issue as a =head2 entry ]
7bd9fb10 37
a8ba758d 38=head1 Incompatible Changes
7bd9fb10 39
a8ba758d 40XXX For a release on a stable branch, this section aspires to be:
7bd9fb10 41
a8ba758d
JSA
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.
7bd9fb10 45
a8ba758d 46[ List each incompatible change as a =head2 entry ]
7bd9fb10 47
a8ba758d 48=head1 Deprecations
7bd9fb10 49
a8ba758d 50XXX Any deprecated features, syntax, modules etc. should be listed here.
7bd9fb10 51
a8ba758d 52=head2 Module removals
7bd9fb10 53
a8ba758d 54XXX Remove this section if inapplicable.
7bd9fb10 55
a8ba758d
JSA
56The following modules will be removed from the core distribution in a
57future release, and will at that time need to be installed from CPAN.
58Distributions on CPAN which require these modules will need to list them as
59prerequisites.
60
61The core versions of these modules will now issue C<"deprecated">-category
62warnings to alert you to this fact. To silence these deprecation warnings,
63install the modules in question from CPAN.
c83a3d01 64
a8ba758d
JSA
65Note that these are (with rare exceptions) fine modules that you are encouraged
66to continue to use. Their disinclusion from core primarily hinges on their
67necessity to bootstrapping a fully functional, CPAN-capable Perl installation,
68not usually on concerns over their design.
d1107db0 69
a8ba758d 70=over
d1107db0 71
a8ba758d 72=item XXX
d1107db0 73
a8ba758d
JSA
74XXX Note that deprecated modules should be listed here even if they are listed
75as an updated module in the L</Modules and Pragmata> section.
d1107db0 76
a8ba758d 77=back
d1107db0 78
a8ba758d 79[ List each other deprecation as a =head2 entry ]
d1107db0 80
cf663f87
AC
81=head1 Performance Enhancements
82
a8ba758d
JSA
83XXX Changes which enhance performance without changing behaviour go here.
84There may well be none in a stable release.
85
86[ List each enhancement as an =item entry ]
87
1b510166
S
88=over 4
89
90=item *
91
93309f6b
TC
92Calls to C<require> for an already loaded module are now slightly
93faster. [perl #132171]
d912eab8 94
c83a3d01 95=back
d912eab8 96
c83a3d01 97=head1 Modules and Pragmata
af94b3ac 98
a8ba758d
JSA
99XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
100go here. If Module::CoreList is updated, generate an initial draft of the
101following sections using F<Porting/corelist-perldelta.pl>. A paragraph summary
102for important changes should then be added by hand. In an ideal world,
103dual-life modules would have a F<Changes> file that could be cribbed.
104
105The list of new and updated modules is modified automatically as part of
106preparing a Perl release, so the only reason to manually add entries here is if
107you're summarising the important changes in the module update. (Also, if the
108manually-added details don't match the automatically-generated ones, the
109release manager will have to investigate the situation carefully.)
110
111[ Within each section, list entries as an =item entry ]
112
113=head2 New Modules and Pragmata
c83a3d01
MH
114
115=over 4
ba2fe89f
AC
116
117=item *
118
a8ba758d 119XXX
cf663f87 120
a8ba758d 121=back
cf663f87 122
a8ba758d
JSA
123=head2 Updated Modules and Pragmata
124
125=over 4
ba2fe89f
AC
126
127=item *
128
a8ba758d 129L<XXX> has been upgraded from version A.xx to B.yy.
cf663f87 130
a8ba758d
JSA
131=back
132
133=head2 Removed Modules and Pragmata
f9578da6 134
a8ba758d 135=over 4
f9578da6
MH
136
137=item *
138
a8ba758d 139XXX
f9578da6 140
a8ba758d 141=back
f9578da6 142
a8ba758d 143=head1 Documentation
f9578da6 144
a8ba758d
JSA
145XXX Changes to files in F<pod/> go here. Consider grouping entries by
146file and be sure to link to the appropriate page, e.g. L<perlfunc>.
f9578da6 147
a8ba758d 148=head2 New Documentation
f9578da6 149
a8ba758d 150XXX Changes which create B<new> files in F<pod/> go here.
f9578da6 151
a8ba758d 152=head3 L<XXX>
c83a3d01 153
a8ba758d 154XXX Description of the purpose of the new file here
c83a3d01 155
a8ba758d
JSA
156=head2 Changes to Existing Documentation
157
158We have attempted to update the documentation to reflect the changes
159listed in this document. If you find any we have missed, send email
160to L<perlbug@perl.org|mailto:perlbug@perl.org>.
161
162XXX Changes which significantly change existing files in F<pod/> go here.
163However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
164section.
165
166Additionally, the following selected changes have been made:
167
168=head3 L<XXX>
c83a3d01
MH
169
170=over 4
f9578da6
MH
171
172=item *
173
a8ba758d 174XXX Description of the change here
c83a3d01
MH
175
176=back
177
21741043 178=head1 Diagnostics
c83a3d01 179
21741043
JSA
180The following additions or changes have been made to diagnostic output,
181including warnings and fatal error messages. For the complete list of
182diagnostic messages, see L<perldiag>.
c83a3d01 183
a8ba758d
JSA
184XXX New or changed warnings emitted by the core's C<C> code go here. Also
185include any changes in L<perldiag> that reconcile it to the C<C> code.
186
187=head2 New Diagnostics
188
189XXX Newly added diagnostic messages go under here, separated into New Errors
190and New Warnings
191
192=head3 New Errors
c83a3d01
MH
193
194=over 4
f9578da6
MH
195
196=item *
197
a8ba758d 198XXX L<message|perldiag/"message">
c83a3d01
MH
199
200=back
201
a8ba758d 202=head3 New Warnings
c83a3d01 203
a8ba758d 204=over 4
c83a3d01 205
a8ba758d 206=item *
c83a3d01 207
a8ba758d
JSA
208XXX L<message|perldiag/"message">
209
210=back
211
212=head2 Changes to Existing Diagnostics
213
214XXX Changes (i.e. rewording) of diagnostic messages go here
c83a3d01 215
c83a3d01
MH
216=over 4
217
a8ba758d 218=item *
c83a3d01 219
a8ba758d 220XXX Describe change here
c83a3d01
MH
221
222=back
223
a8ba758d
JSA
224=head1 Utility Changes
225
226XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here.
227Most of these are built within the directory F<utils>.
228
229[ List utility changes as a =head2 entry for each utility and =item
230entries for each change
231Use L<XXX> with program names to get proper documentation linking. ]
232
233=head2 L<XXX>
c83a3d01 234
cf663f87 235=over 4
1b510166 236
3072e759
TC
237=item *
238
a8ba758d 239XXX
cf663f87 240
a8ba758d
JSA
241=back
242
243=head1 Configuration and Compilation
244
245XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
246go here. Any other changes to the Perl build process should be listed here.
247However, any platform-specific changes should be listed in the
248L</Platform Support> section, instead.
dcce18ed 249
a8ba758d
JSA
250[ List changes as an =item entry ].
251
252=over 4
dcce18ed 253
21741043 254=item *
cf663f87 255
a8ba758d 256XXX
cf663f87 257
21741043 258=back
c83a3d01 259
a8ba758d
JSA
260=head1 Testing
261
262XXX Any significant changes to the testing of a freshly built perl should be
263listed here. Changes which create B<new> files in F<t/> go here as do any
264large changes to the testing harness (e.g. when parallel testing was added).
265Changes to existing files in F<t/> aren't worth summarizing, although the bugs
266that they represent may be covered elsewhere.
267
268XXX If there were no significant test changes, say this:
269
270Tests were added and changed to reflect the other additions and changes
271in this release.
272
273XXX If instead there were significant changes, say this:
274
275Tests were added and changed to reflect the other additions and
276changes in this release. Furthermore, these significant changes were
277made:
278
279[ List each test improvement as an =item entry ]
c83a3d01 280
cf663f87 281=over 4
ab9a6a63
AC
282
283=item *
284
a8ba758d 285XXX
011c35bc 286
a8ba758d 287=back
011c35bc 288
a8ba758d 289=head1 Platform Support
cf663f87 290
a8ba758d 291XXX Any changes to platform support should be listed in the sections below.
eed68fe8 292
a8ba758d
JSA
293[ Within the sections, list each platform as an =item entry with specific
294changes as paragraphs below it. ]
eed68fe8 295
a8ba758d 296=head2 New Platforms
cb87b182 297
a8ba758d
JSA
298XXX List any platforms that this version of perl compiles on, that previous
299versions did not. These will either be enabled by new files in the F<hints/>
300directories, or new subdirectories and F<README> files at the top level of the
301source tree.
cb87b182 302
a8ba758d 303=over 4
5609e953 304
a8ba758d 305=item XXX-some-platform
5609e953 306
a8ba758d 307XXX
dcce18ed 308
a8ba758d 309=back
dcce18ed 310
a8ba758d 311=head2 Discontinued Platforms
773582e3 312
a8ba758d 313XXX List any platforms that this version of perl no longer compiles on.
c83a3d01 314
a8ba758d 315=over 4
c83a3d01 316
a8ba758d 317=item XXX-some-platform
c83a3d01 318
a8ba758d
JSA
319XXX
320
321=back
322
323=head2 Platform-Specific Notes
324
325XXX List any changes for specific platforms. This could include configuration
326and compilation changes or changes in portability/compatibility. However,
327changes within modules for platforms should generally be listed in the
328L</Modules and Pragmata> section.
329
330=over 4
9ef07b78 331
a8ba758d
JSA
332=item XXX-some-platform
333
334XXX
335
336=back
337
338=head1 Internal Changes
339
340XXX Changes which affect the interface available to C<XS> code go here. Other
341significant internal changes for future core maintainers should be noted as
342well.
343
344[ List each change as an =item entry ]
345
346=over 4
9ef07b78 347
70268191
TC
348=item *
349
a8ba758d
JSA
350XXX
351
352=back
353
354=head1 Selected Bug Fixes
355
356XXX Important bug fixes in the core language are summarized here. Bug fixes in
357files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>.
358
359[ List each fix as an =item entry ]
360
361=over 4
cf663f87 362
21741043 363=item *
c83a3d01 364
44246694
DIM
365Calling L<exec PROGRAM LIST|perlfunc/exec PROGRAM LIST> with an empty C<LIST>
366has been fixed. This should call C<execvp()> with an empty C<argv> array
367(containing only the terminating C<NULL> pointer), but was instead just
368returning false (and not setting L<C<$!>|perlvar/$!>).
369L<[perl #131730]|https://rt.perl.org/Public/Bug/Display.html?id=131730>
a8ba758d 370
834e1dc6
FC
371=item *
372
373The C<gv_fetchmeth_sv> C function stopped working properly in Perl 5.22
374when fetching a constant with a UTF-8 name if that constant subroutine was
375stored in the stash as a simple scalar reference, rather than a full
376typeglob. This has been corrected.
377
a8ba758d
JSA
378=back
379
380=head1 Known Problems
381
382XXX Descriptions of platform agnostic bugs we know we can't fix go here. Any
383tests that had to be C<TODO>ed for the release would be noted here. Unfixed
384platform specific bugs also go here.
385
386[ List each fix as an =item entry ]
387
388=over 4
8abafd33 389
c83a3d01
MH
390=item *
391
a8ba758d 392XXX
8abafd33 393
c83a3d01 394=back
cf663f87 395
a8ba758d 396=head1 Errata From Previous Releases
8abafd33 397
a8ba758d 398=over 4
cf663f87 399
a8ba758d 400=item *
21741043 401
a8ba758d
JSA
402XXX Add anything here that we forgot to add, or were mistaken about, in
403the perldelta of a previous release.
21741043 404
a8ba758d 405=back
21741043 406
a8ba758d
JSA
407=head1 Obituary
408
409XXX If any significant core contributor has died, we've added a short obituary
410here.
411
412=head1 Acknowledgements
8abafd33 413
a8ba758d 414XXX Generate this with:
8abafd33 415
a8ba758d 416 perl Porting/acknowledgements.pl v5.25.5..HEAD
f5b73711 417
44691e6f
AB
418=head1 Reporting Bugs
419
b5cbfe35
S
420If you find what you think is a bug, you might check the perl bug database
421at L<https://rt.perl.org/> . There may also be information at
422L<http://www.perl.org/> , the Perl Home Page.
44691e6f 423
e08634c5
SH
424If you believe you have an unreported bug, please run the L<perlbug> program
425included with your release. Be sure to trim your bug down to a tiny but
426sufficient test case. Your bug report, along with the output of C<perl -V>,
b5cbfe35 427will be sent off to perlbug@perl.org to be analysed by the Perl porting team.
44691e6f 428
87c118b9
DM
429If the bug you are reporting has security implications which make it
430inappropriate to send to a publicly archived mailing list, then see
c0ea3294
SH
431L<perlsec/SECURITY VULNERABILITY CONTACT INFORMATION>
432for details of how to report the issue.
44691e6f 433
390ae6f9
S
434=head1 Give Thanks
435
436If you wish to thank the Perl 5 Porters for the work we had done in Perl 5,
437you can do so by running the C<perlthanks> program:
438
439 perlthanks
440
441This will send an email to the Perl 5 Porters list with your show of thanks.
442
44691e6f
AB
443=head1 SEE ALSO
444
e08634c5
SH
445The F<Changes> file for an explanation of how to view exhaustive details on
446what changed.
44691e6f
AB
447
448The F<INSTALL> file for how to build Perl.
449
450The F<README> file for general stuff.
451
452The F<Artistic> and F<Copying> files for copyright information.
453
454=cut