This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Update Module::CoreList for 5.27.0
[perl5.git] / pod / perldelta.pod
CommitLineData
44691e6f
AB
1=encoding utf8
2
3=head1 NAME
4
b5cbfe35
S
5[ this is a template for a new perldelta file. Any text flagged as XXX needs
6to be processed before release. ]
eabfc7bc 7
b5cbfe35 8perldelta - what is new for perl v5.27.0
89853d76 9
b5cbfe35 10=head1 DESCRIPTION
89853d76 11
b5cbfe35
S
12This document describes differences between the 5.26.0 release and the 5.27.0
13release.
89853d76 14
b5cbfe35
S
15If you are upgrading from an earlier release such as 5.25.0, first read
16L<perl5260delta>, which describes differences between 5.25.0 and 5.26.0.
16beba24 17
b5cbfe35 18=head1 Notice
16beba24 19
b5cbfe35 20XXX Any important notices here
89853d76 21
2c8edc25 22=head1 Core Enhancements
f3ed8cbf 23
b5cbfe35
S
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.
22a7b456 27
b5cbfe35 28[ List each enhancement as a =head2 entry ]
22a7b456 29
a049258c
S
30=head1 Security
31
b5cbfe35
S
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.
89853d76 35
b5cbfe35 36[ List each security issue as a =head2 entry ]
89853d76 37
b5cbfe35 38=head1 Incompatible Changes
89853d76 39
b5cbfe35 40XXX For a release on a stable branch, this section aspires to be:
89853d76 41
b5cbfe35
S
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.
89853d76 45
b5cbfe35 46[ List each incompatible change as a =head2 entry ]
89853d76 47
b5cbfe35 48=head1 Deprecations
89853d76 49
b5cbfe35 50XXX Any deprecated features, syntax, modules etc. should be listed here.
89853d76 51
b5cbfe35 52=head2 Module removals
89853d76 53
b5cbfe35 54XXX Remove this section if inapplicable.
89853d76 55
b5cbfe35
S
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.
89853d76 60
b5cbfe35
S
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.
89853d76 64
b5cbfe35
S
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.
89853d76
DH
69
70=over
71
b5cbfe35 72=item XXX
89853d76 73
b5cbfe35
S
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.
89853d76
DH
76
77=back
2c8edc25 78
b5cbfe35 79[ List each other deprecation as a =head2 entry ]
1f81bc18 80
2c8edc25 81=head1 Performance Enhancements
a049258c 82
b5cbfe35
S
83XXX Changes which enhance performance without changing behaviour go here.
84There may well be none in a stable release.
a049258c 85
b5cbfe35 86[ List each enhancement as a =item entry ]
a049258c 87
b5cbfe35 88=over 4
2c8edc25
S
89
90=item *
91
b5cbfe35 92XXX
d053832c 93
b5cbfe35 94=back
2c8edc25 95
b5cbfe35 96=head1 Modules and Pragmata
2c8edc25 97
b5cbfe35
S
98XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
99go here. If Module::CoreList is updated, generate an initial draft of the
100following sections using F<Porting/corelist-perldelta.pl>. A paragraph summary
101for important changes should then be added by hand. In an ideal world,
102dual-life modules would have a F<Changes> file that could be cribbed.
96e0fd86 103
b5cbfe35 104[ Within each section, list entries as a =item entry ]
2c8edc25 105
b5cbfe35 106=head2 New Modules and Pragmata
2c8edc25 107
b5cbfe35 108=over 4
7ca0bfc4 109
fbe3f407
S
110=item *
111
b5cbfe35 112XXX
a049258c
S
113
114=back
115
116=head2 Updated Modules and Pragmata
117
118=over 4
fbe3f407 119
759020c9 120=item *
7ca0bfc4 121
b5cbfe35 122L<XXX> has been upgraded from version A.xx to B.yy.
0cc8c746 123
b5cbfe35 124=back
0cc8c746 125
b5cbfe35 126=head2 Removed Modules and Pragmata
0cc8c746 127
b5cbfe35 128=over 4
0cc8c746
S
129
130=item *
131
b5cbfe35 132XXX
0cc8c746 133
b5cbfe35 134=back
0cc8c746 135
b5cbfe35 136=head1 Documentation
0cc8c746 137
b5cbfe35
S
138XXX Changes to files in F<pod/> go here. Consider grouping entries by
139file and be sure to link to the appropriate page, e.g. L<perlfunc>.
0cc8c746 140
b5cbfe35 141=head2 New Documentation
a049258c 142
b5cbfe35 143XXX Changes which create B<new> files in F<pod/> go here.
a049258c 144
b5cbfe35 145=head3 L<XXX>
a049258c 146
b5cbfe35 147XXX Description of the purpose of the new file here
0cc8c746 148
b5cbfe35 149=head2 Changes to Existing Documentation
0cc8c746 150
b5cbfe35
S
151XXX Changes which significantly change existing files in F<pod/> go here.
152However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
153section.
0cc8c746 154
b5cbfe35 155=head3 L<XXX>
0cc8c746 156
b5cbfe35 157=over 4
0cc8c746
S
158
159=item *
160
b5cbfe35 161XXX Description of the change here
a049258c 162
b5cbfe35 163=back
a049258c 164
b5cbfe35 165=head1 Diagnostics
a049258c 166
b5cbfe35
S
167The following additions or changes have been made to diagnostic output,
168including warnings and fatal error messages. For the complete list of
169diagnostic messages, see L<perldiag>.
a049258c 170
b5cbfe35
S
171XXX New or changed warnings emitted by the core's C<C> code go here. Also
172include any changes in L<perldiag> that reconcile it to the C<C> code.
7ca0bfc4 173
b5cbfe35 174=head2 New Diagnostics
7ca0bfc4 175
b5cbfe35
S
176XXX Newly added diagnostic messages go under here, separated into New Errors
177and New Warnings
0cc8c746 178
b5cbfe35 179=head3 New Errors
0cc8c746 180
b5cbfe35 181=over 4
0cc8c746
S
182
183=item *
184
b5cbfe35 185XXX L<message|perldiag/"message">
0cc8c746 186
b5cbfe35 187=back
0cc8c746 188
b5cbfe35 189=head3 New Warnings
0cc8c746 190
b5cbfe35 191=over 4
0cc8c746
S
192
193=item *
194
b5cbfe35 195XXX L<message|perldiag/"message">
8f7edc68 196
b5cbfe35 197=back
d5c7a4fc 198
b5cbfe35 199=head2 Changes to Existing Diagnostics
d5c7a4fc 200
b5cbfe35 201XXX Changes (i.e. rewording) of diagnostic messages go here
a049258c 202
b5cbfe35 203=over 4
a049258c 204
2c8edc25 205=item *
d5c7a4fc 206
b5cbfe35 207XXX Describe change here
a049258c 208
b5cbfe35 209=back
3abe9611 210
b5cbfe35 211=head1 Utility Changes
3ce6a296 212
b5cbfe35
S
213XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here.
214Most of these are built within the directory F<utils>.
a049258c 215
b5cbfe35
S
216[ List utility changes as a =head2 entry for each utility and =item
217entries for each change
218Use L<XXX> with program names to get proper documentation linking. ]
a049258c 219
b5cbfe35 220=head2 L<XXX>
a049258c 221
b5cbfe35 222=over 4
0cc8c746
S
223
224=item *
225
b5cbfe35 226XXX
0cc8c746 227
b5cbfe35 228=back
0cc8c746 229
b5cbfe35 230=head1 Configuration and Compilation
0cc8c746 231
b5cbfe35
S
232XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
233go here. Any other changes to the Perl build process should be listed here.
234However, any platform-specific changes should be listed in the
235L</Platform Support> section, instead.
0cc8c746 236
b5cbfe35 237[ List changes as a =item entry ].
0cc8c746 238
b5cbfe35 239=over 4
2c8edc25 240
a049258c 241=item *
5c92a635 242
b5cbfe35 243XXX
0cc8c746 244
b5cbfe35 245=back
0cc8c746 246
b5cbfe35 247=head1 Testing
0cc8c746 248
b5cbfe35
S
249XXX Any significant changes to the testing of a freshly built perl should be
250listed here. Changes which create B<new> files in F<t/> go here as do any
251large changes to the testing harness (e.g. when parallel testing was added).
252Changes to existing files in F<t/> aren't worth summarizing, although the bugs
253that they represent may be covered elsewhere.
0cc8c746 254
b5cbfe35 255[ List each test improvement as a =item entry ]
d5c7a4fc 256
b5cbfe35 257=over 4
d5c7a4fc 258
2c8edc25 259=item *
d5c7a4fc 260
b5cbfe35 261XXX
0cc8c746 262
b5cbfe35 263=back
0cc8c746 264
b5cbfe35 265=head1 Platform Support
0cc8c746 266
b5cbfe35 267XXX Any changes to platform support should be listed in the sections below.
a049258c 268
b5cbfe35
S
269[ Within the sections, list each platform as a =item entry with specific
270changes as paragraphs below it. ]
64afbd29 271
b5cbfe35 272=head2 New Platforms
64afbd29 273
b5cbfe35
S
274XXX List any platforms that this version of perl compiles on, that previous
275versions did not. These will either be enabled by new files in the F<hints/>
276directories, or new subdirectories and F<README> files at the top level of the
277source tree.
0cc8c746 278
b5cbfe35 279=over 4
0cc8c746 280
b5cbfe35 281=item XXX-some-platform
0cc8c746 282
b5cbfe35 283XXX
0cc8c746 284
b5cbfe35 285=back
0cc8c746 286
b5cbfe35 287=head2 Discontinued Platforms
0cc8c746 288
b5cbfe35 289XXX List any platforms that this version of perl no longer compiles on.
a049258c 290
b5cbfe35 291=over 4
a049258c 292
b5cbfe35 293=item XXX-some-platform
a049258c 294
b5cbfe35 295XXX
a049258c 296
b5cbfe35 297=back
a049258c 298
b5cbfe35 299=head2 Platform-Specific Notes
a049258c 300
b5cbfe35
S
301XXX List any changes for specific platforms. This could include configuration
302and compilation changes or changes in portability/compatibility. However,
303changes within modules for platforms should generally be listed in the
304L</Modules and Pragmata> section.
0cc8c746 305
b5cbfe35 306=over 4
0cc8c746 307
b5cbfe35 308=item XXX-some-platform
0cc8c746 309
b5cbfe35 310XXX
0cc8c746 311
b5cbfe35 312=back
0cc8c746 313
b5cbfe35 314=head1 Internal Changes
0cc8c746 315
b5cbfe35
S
316XXX Changes which affect the interface available to C<XS> code go here. Other
317significant internal changes for future core maintainers should be noted as
318well.
0cc8c746 319
b5cbfe35 320[ List each change as a =item entry ]
0cc8c746 321
b5cbfe35 322=over 4
0cc8c746
S
323
324=item *
325
b5cbfe35 326XXX
2c8edc25 327
b5cbfe35 328=back
faab9793 329
b5cbfe35 330=head1 Selected Bug Fixes
ad5c8857 331
b5cbfe35
S
332XXX Important bug fixes in the core language are summarized here. Bug fixes in
333files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>.
0cc8c746 334
b5cbfe35 335[ List each fix as a =item entry ]
0cc8c746 336
b5cbfe35 337=over 4
0cc8c746
S
338
339=item *
340
b5cbfe35 341XXX
0cc8c746 342
b5cbfe35 343=back
0cc8c746 344
b5cbfe35 345=head1 Known Problems
0cc8c746 346
b5cbfe35
S
347XXX Descriptions of platform agnostic bugs we know we can't fix go here. Any
348tests that had to be C<TODO>ed for the release would be noted here. Unfixed
349platform specific bugs also go here.
ad5c8857 350
b5cbfe35 351[ List each fix as a =item entry ]
2e0dcc12 352
b5cbfe35 353=over 4
0cc8c746
S
354
355=item *
356
b5cbfe35 357XXX
0cc8c746 358
b5cbfe35 359=back
0cc8c746 360
b5cbfe35 361=head1 Errata From Previous Releases
0cc8c746 362
b5cbfe35 363=over 4
0cc8c746
S
364
365=item *
366
b5cbfe35
S
367XXX Add anything here that we forgot to add, or were mistaken about, in
368the perldelta of a previous release.
0cc8c746 369
b5cbfe35 370=back
0cc8c746 371
b5cbfe35 372=head1 Obituary
0cc8c746 373
b5cbfe35
S
374XXX If any significant core contributor has died, we've added a short obituary
375here.
0cc8c746 376
b5cbfe35 377=head1 Acknowledgements
0cc8c746 378
b5cbfe35 379XXX Generate this with:
2e0dcc12 380
b5cbfe35 381 perl Porting/acknowledgements.pl v5.25.5..HEAD
f5b73711 382
44691e6f
AB
383=head1 Reporting Bugs
384
b5cbfe35
S
385If you find what you think is a bug, you might check the perl bug database
386at L<https://rt.perl.org/> . There may also be information at
387L<http://www.perl.org/> , the Perl Home Page.
44691e6f 388
e08634c5
SH
389If you believe you have an unreported bug, please run the L<perlbug> program
390included with your release. Be sure to trim your bug down to a tiny but
391sufficient test case. Your bug report, along with the output of C<perl -V>,
b5cbfe35 392will be sent off to perlbug@perl.org to be analysed by the Perl porting team.
44691e6f 393
87c118b9
DM
394If the bug you are reporting has security implications which make it
395inappropriate to send to a publicly archived mailing list, then see
c0ea3294
SH
396L<perlsec/SECURITY VULNERABILITY CONTACT INFORMATION>
397for details of how to report the issue.
44691e6f 398
390ae6f9
S
399=head1 Give Thanks
400
401If you wish to thank the Perl 5 Porters for the work we had done in Perl 5,
402you can do so by running the C<perlthanks> program:
403
404 perlthanks
405
406This will send an email to the Perl 5 Porters list with your show of thanks.
407
44691e6f
AB
408=head1 SEE ALSO
409
e08634c5
SH
410The F<Changes> file for an explanation of how to view exhaustive details on
411what changed.
44691e6f
AB
412
413The F<INSTALL> file for how to build Perl.
414
415The F<README> file for general stuff.
416
417The F<Artistic> and F<Copying> files for copyright information.
418
419=cut