This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Straighten Porting/Maintainers.pl out following Test::Simple restoration
[perl5.git] / pod / perldelta.pod
CommitLineData
44691e6f
AB
1=encoding utf8
2
3=head1 NAME
4
a9c3e753
S
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.21.10
c68523cb 9
238894db 10=head1 DESCRIPTION
c68523cb 11
a9c3e753 12This document describes differences between the 5.21.9 release and the 5.21.10
238894db 13release.
c68523cb 14
a9c3e753
S
15If you are upgrading from an earlier release such as 5.21.8, first read
16L<perl5219delta>, which describes differences between 5.21.8 and 5.21.9.
2ec11c70 17
b5d4d3b9 18=head1 Notice
2ec11c70 19
a9c3e753 20XXX Any important notices here
67f2cc75 21
b5d4d3b9 22=head1 Core Enhancements
67f2cc75 23
a9c3e753
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.
06ae2722 27
a9c3e753 28[ List each enhancement as a =head2 entry ]
156f41cf 29
a9c3e753 30=head1 Security
156f41cf 31
a9c3e753
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.
156f41cf 35
a9c3e753 36[ List each security issue as a =head2 entry ]
48c4d243 37
b5d4d3b9 38=head1 Incompatible Changes
ef8784b7 39
a9c3e753 40XXX For a release on a stable branch, this section aspires to be:
541e1e0d 41
a9c3e753
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.
541e1e0d 45
a9c3e753 46[ List each incompatible change as a =head2 entry ]
541e1e0d 47
a9c3e753 48=head1 Deprecations
541e1e0d 49
a9c3e753 50XXX Any deprecated features, syntax, modules etc. should be listed here.
541e1e0d 51
a9c3e753 52=head2 Module removals
541e1e0d 53
a9c3e753 54XXX Remove this section if inapplicable.
541e1e0d 55
a9c3e753
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.
cd7bac54 60
a9c3e753
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.
541e1e0d 64
a9c3e753
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.
541e1e0d 69
a9c3e753 70=over
cd7bac54 71
a9c3e753 72=item XXX
6c8457e9 73
a9c3e753
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.
cd7bac54
S
76
77=back
6c8457e9 78
a9c3e753 79[ List each other deprecation as a =head2 entry ]
6c8457e9 80
a9c3e753 81=head1 Performance Enhancements
6c8457e9 82
a9c3e753
S
83XXX Changes which enhance performance without changing behaviour go here.
84There may well be none in a stable release.
127a7155 85
a9c3e753 86[ List each enhancement as a =item entry ]
6c8457e9 87
cd7bac54
S
88=over 4
89
90=item *
91
a9c3e753 92XXX
cd7bac54
S
93
94=back
95
a9c3e753 96=head1 Modules and Pragmata
0939a951 97
a9c3e753
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.
c49582c3 103
a9c3e753 104[ Within each section, list entries as a =item entry ]
9024667a 105
a9c3e753 106=head2 New Modules and Pragmata
31e72f27
KW
107
108=over 4
109
110=item *
111
a9c3e753 112XXX
0ce5e53e 113
31e72f27
KW
114=back
115
a9c3e753 116=head2 Updated Modules and Pragmata
cd7bac54 117
a9c3e753 118=over 4
cd7bac54
S
119
120=item *
121
b9c683b3
TC
122L<B::Deparse> has been upgraded from version 1.33 to 1.34.
123
124Deparse C<$#_> as that instead of as C<$#{_}>. [perl #123947]
125
126=item *
127
79116533
SH
128L<CPAN> has been upgraded from version 2.05 to 2.09-TRIAL.
129
130=over 4
131
132=item *
133
134Add support for C<Cwd::getdcwd()> and introduce workaround for a misbehaviour
135seen on Strawberry Perl 5.20.1.
136
137=item *
138
139Fix C<chdir()> after building dependencies bug.
140
141=item *
142
143Introduce experimental support for plugins/hooks.
144
145=item *
146
147Integrate the App::Cpan sources.
148
149=item *
150
151Do not check recursion on optional dependencies.
152
153=item *
154
155Sanity check META.yml to contain a hash.
156L<[cpan #95271]|https://rt.cpan.org/Ticket/Display.html?id=95271>
157
158=back
0939a951 159
c0ff9143
JH
160=item *
161
03a97c81
SH
162L<Text::Balanced> has been upgraded from version 2.02 to 2.03.
163
164No changes to installed files other than the version bump.
165
166=item *
167
ca2f5fd9 168L<threads> has been upgraded from version 1.96 to 1.99.
c0ff9143 169
a9c3e753 170=back
0939a951 171
a9c3e753 172=head2 Removed Modules and Pragmata
cd7bac54 173
a9c3e753 174=over 4
cd7bac54
S
175
176=item *
177
a9c3e753 178XXX
cd7bac54 179
2ff1ebfe 180=back
541e1e0d 181
cd7bac54
S
182=head1 Documentation
183
a9c3e753
S
184XXX Changes to files in F<pod/> go here. Consider grouping entries by
185file and be sure to link to the appropriate page, e.g. L<perlfunc>.
186
cd7bac54
S
187=head2 New Documentation
188
a9c3e753 189XXX Changes which create B<new> files in F<pod/> go here.
541e1e0d 190
a9c3e753 191=head3 L<XXX>
d676fe86 192
a9c3e753 193XXX Description of the purpose of the new file here
d676fe86 194
a9c3e753 195=head2 Changes to Existing Documentation
d2fff9f6 196
a9c3e753
S
197XXX Changes which significantly change existing files in F<pod/> go here.
198However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
199section.
d2fff9f6 200
a9c3e753 201=head3 L<XXX>
e329daf3 202
cd7bac54 203=over 4
e329daf3 204
cd7bac54 205=item *
e329daf3 206
a9c3e753 207XXX Description of the change here
ba31029d 208
cd7bac54
S
209=back
210
a9c3e753 211=head1 Diagnostics
cd7bac54 212
a9c3e753
S
213The following additions or changes have been made to diagnostic output,
214including warnings and fatal error messages. For the complete list of
215diagnostic messages, see L<perldiag>.
cd7bac54 216
a9c3e753
S
217XXX New or changed warnings emitted by the core's C<C> code go here. Also
218include any changes in L<perldiag> that reconcile it to the C<C> code.
cd7bac54 219
a9c3e753 220=head2 New Diagnostics
541e1e0d 221
a9c3e753
S
222XXX Newly added diagnostic messages go under here, separated into New Errors
223and New Warnings
541e1e0d 224
a9c3e753 225=head3 New Errors
cd7bac54
S
226
227=over 4
228
229=item *
230
a9c3e753 231XXX L<message|perldiag/"message">
cd7bac54
S
232
233=back
541e1e0d 234
a9c3e753 235=head3 New Warnings
541e1e0d 236
2ff1ebfe 237=over 4
aa67537d 238
4c7a0d98
DD
239=item *
240
a9c3e753 241XXX L<message|perldiag/"message">
4c7a0d98 242
b5d4d3b9 243=back
4c7a0d98 244
a9c3e753 245=head2 Changes to Existing Diagnostics
a5d66edf 246
a9c3e753 247XXX Changes (i.e. rewording) of diagnostic messages go here
f348c3d8 248
cd7bac54 249=over 4
f348c3d8 250
cd7bac54 251=item *
2ff1ebfe 252
a9c3e753 253XXX Describe change here
f348c3d8 254
cd7bac54 255=back
2ff1ebfe 256
a9c3e753 257=head1 Utility Changes
f348c3d8 258
a9c3e753
S
259XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here.
260Most of these are built within the directory F<utils>.
4dc623f0 261
a9c3e753
S
262[ List utility changes as a =head2 entry for each utility and =item
263entries for each change
264Use L<XXX> with program names to get proper documentation linking. ]
84d03adf 265
a9c3e753 266=head2 L<XXX>
ff433f2d 267
9ce6583e 268=over 4
4cd408ba 269
9ce6583e 270=item *
6ed80d55 271
a9c3e753 272XXX
9ce6583e 273
2ff1ebfe 274=back
ab0b796c 275
a9c3e753 276=head1 Configuration and Compilation
cd7bac54 277
a9c3e753
S
278XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
279go here. Any other changes to the Perl build process should be listed here.
280However, any platform-specific changes should be listed in the
281L</Platform Support> section, instead.
cd7bac54 282
a9c3e753 283[ List changes as a =item entry ].
8c6180a9 284
2ff1ebfe 285=over 4
0561e60b 286
9ce6583e 287=item *
dd200dff 288
a9c3e753 289XXX
c877af1b 290
cd7bac54 291=back
c877af1b 292
a9c3e753 293=head1 Testing
cd7bac54 294
a9c3e753
S
295XXX Any significant changes to the testing of a freshly built perl should be
296listed here. Changes which create B<new> files in F<t/> go here as do any
297large changes to the testing harness (e.g. when parallel testing was added).
298Changes to existing files in F<t/> aren't worth summarizing, although the bugs
299that they represent may be covered elsewhere.
cd7bac54 300
a9c3e753 301[ List each test improvement as a =item entry ]
bb8c7e27 302
b5d4d3b9 303=over 4
83b69bfd
DD
304
305=item *
306
a9c3e753 307XXX
13adb056 308
b5d4d3b9 309=back
391823f2 310
a9c3e753 311=head1 Platform Support
6c8457e9 312
a9c3e753 313XXX Any changes to platform support should be listed in the sections below.
6c8457e9 314
a9c3e753
S
315[ Within the sections, list each platform as a =item entry with specific
316changes as paragraphs below it. ]
db98db4e 317
a9c3e753 318=head2 New Platforms
8818afe8 319
a9c3e753
S
320XXX List any platforms that this version of perl compiles on, that previous
321versions did not. These will either be enabled by new files in the F<hints/>
322directories, or new subdirectories and F<README> files at the top level of the
323source tree.
8af808bf 324
2ff1ebfe 325=over 4
fdcaecb7 326
a9c3e753 327=item XXX-some-platform
fdcaecb7 328
a9c3e753 329XXX
2af7c6b6 330
4dc623f0 331=back
2af7c6b6 332
a9c3e753
S
333=head2 Discontinued Platforms
334
335XXX List any platforms that this version of perl no longer compiles on.
70cee83f 336
b5d4d3b9 337=over 4
e5fbfbc1 338
a9c3e753 339=item XXX-some-platform
b4045391 340
a9c3e753 341XXX
b4045391 342
2ff1ebfe 343=back
b4045391 344
2ff1ebfe 345=head2 Platform-Specific Notes
8c847e66 346
a9c3e753
S
347XXX List any changes for specific platforms. This could include configuration
348and compilation changes or changes in portability/compatibility. However,
349changes within modules for platforms should generally be listed in the
350L</Modules and Pragmata> section.
8c847e66 351
2ff1ebfe 352=over 4
d345f487 353
a9c3e753 354=item XXX-some-platform
d345f487 355
a9c3e753 356XXX
cd7bac54 357
4dc623f0 358=back
353075a0 359
a9c3e753 360=head1 Internal Changes
9f122eef 361
a9c3e753
S
362XXX Changes which affect the interface available to C<XS> code go here. Other
363significant internal changes for future core maintainers should be noted as
364well.
2ff1ebfe 365
a9c3e753 366[ List each change as a =item entry ]
2ff1ebfe 367
b5d4d3b9 368=over 4
2ec11c70
DM
369
370=item *
371
a9c3e753 372XXX
2683609f 373
4dc623f0 374=back
c7f058f0 375
4dc623f0 376=head1 Selected Bug Fixes
0ef4323a 377
a9c3e753
S
378XXX Important bug fixes in the core language are summarized here. Bug fixes in
379files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>.
567291b6 380
a9c3e753 381[ List each fix as a =item entry ]
436f6503 382
a9c3e753 383=over 4
2bf83140 384
041a5927
FC
385=item *
386
5268e911
TC
387Repeated global pattern matches in scalar context on large tainted
388strings were exponentially slow depending on the current match
389position in the string. [perl #123202]
041a5927 390
a9c3e753 391=back
ea13b07e 392
a9c3e753 393=head1 Known Problems
b65adbec 394
a9c3e753
S
395XXX Descriptions of platform agnostic bugs we know we can't fix go here. Any
396tests that had to be C<TODO>ed for the release would be noted here. Unfixed
397platform specific bugs also go here.
b65adbec 398
a9c3e753 399[ List each fix as a =item entry ]
370c71c5 400
a9c3e753 401=over 4
b94c7836
FC
402
403=item *
404
a9c3e753 405XXX
439f6100 406
a9c3e753 407=back
e3e8f263 408
a9c3e753 409=head1 Errata From Previous Releases
cd7bac54 410
a9c3e753 411=over 4
e3e8f263 412
cb6cc22b
TC
413=item *
414
a9c3e753
S
415XXX Add anything here that we forgot to add, or were mistaken about, in
416the perldelta of a previous release.
cb6cc22b 417
b5d4d3b9 418=back
fcfb7b86 419
a9c3e753 420=head1 Obituary
cd7bac54 421
a9c3e753
S
422XXX If any significant core contributor has died, we've added a short obituary
423here.
cd7bac54 424
a9c3e753 425=head1 Acknowledgements
541e1e0d 426
a9c3e753 427XXX Generate this with:
01d42a22 428
a9c3e753 429 perl Porting/acknowledgements.pl v5.21.9..HEAD
f5b73711 430
44691e6f
AB
431=head1 Reporting Bugs
432
e08634c5
SH
433If you find what you think is a bug, you might check the articles recently
434posted to the comp.lang.perl.misc newsgroup and the perl bug database at
238894db 435https://rt.perl.org/ . There may also be information at
7ef8b31d 436http://www.perl.org/ , the Perl Home Page.
44691e6f 437
e08634c5
SH
438If you believe you have an unreported bug, please run the L<perlbug> program
439included with your release. Be sure to trim your bug down to a tiny but
440sufficient test case. Your bug report, along with the output of C<perl -V>,
441will be sent off to perlbug@perl.org to be analysed by the Perl porting team.
44691e6f
AB
442
443If the bug you are reporting has security implications, which make it
e08634c5
SH
444inappropriate to send to a publicly archived mailing list, then please send it
445to perl5-security-report@perl.org. This points to a closed subscription
446unarchived mailing list, which includes all the core committers, who will be
447able to help assess the impact of issues, figure out a resolution, and help
f9001595 448co-ordinate the release of patches to mitigate or fix the problem across all
e08634c5
SH
449platforms on which Perl is supported. Please only use this address for
450security issues in the Perl core, not for modules independently distributed on
451CPAN.
44691e6f
AB
452
453=head1 SEE ALSO
454
e08634c5
SH
455The F<Changes> file for an explanation of how to view exhaustive details on
456what changed.
44691e6f
AB
457
458The F<INSTALL> file for how to build Perl.
459
460The F<README> file for general stuff.
461
462The F<Artistic> and F<Copying> files for copyright information.
463
464=cut