This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
remove obsolete B::CC code from t/harness
[perl5.git] / pod / perldelta.pod
CommitLineData
44691e6f
AB
1=encoding utf8
2
3=head1 NAME
4
b5d4d3b9
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.21.8
c68523cb 9
238894db 10=head1 DESCRIPTION
c68523cb 11
b5d4d3b9 12This document describes differences between the 5.21.7 release and the 5.21.8
238894db 13release.
c68523cb 14
b5d4d3b9
MM
15If you are upgrading from an earlier release such as 5.21.6, first read
16L<perl5217delta>, which describes differences between 5.21.6 and 5.21.7.
2ec11c70 17
b5d4d3b9 18=head1 Notice
2ec11c70 19
b5d4d3b9 20XXX Any important notices here
67f2cc75 21
b5d4d3b9 22=head1 Core Enhancements
67f2cc75 23
b5d4d3b9
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.
67f2cc75 27
b5d4d3b9 28[ List each enhancement as a =head2 entry ]
295f7815 29
b5d4d3b9 30=head1 Security
3f22ed99 31
b5d4d3b9
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.
3f22ed99 35
b5d4d3b9 36[ List each security issue as a =head2 entry ]
aafa61ee 37
b5d4d3b9 38=head1 Incompatible Changes
ef8784b7 39
b5d4d3b9 40XXX For a release on a stable branch, this section aspires to be:
ef8784b7 41
b5d4d3b9
MM
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.
0a7766ab 45
b5d4d3b9 46[ List each incompatible change as a =head2 entry ]
0a7766ab 47
4dc623f0 48=head1 Deprecations
5b306eef 49
b5d4d3b9 50XXX Any deprecated features, syntax, modules etc. should be listed here.
c0659f73 51
b5d4d3b9 52=head2 Module removals
c0659f73 53
b5d4d3b9 54XXX Remove this section if inapplicable.
6ed80d55 55
b5d4d3b9
MM
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.
6ed80d55 60
b5d4d3b9
MM
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.
6ed80d55 64
b5d4d3b9
MM
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.
6ed80d55 69
b5d4d3b9 70=over
bb6a367a 71
b5d4d3b9 72=item XXX
6ed80d55 73
b5d4d3b9
MM
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.
f348c3d8 76
b5d4d3b9 77=back
7635ad4d 78
b5d4d3b9 79[ List each other deprecation as a =head2 entry ]
7635ad4d 80
b5d4d3b9 81=head1 Performance Enhancements
7635ad4d 82
b5d4d3b9
MM
83XXX Changes which enhance performance without changing behaviour go here.
84There may well be none in a stable release.
60dde9d3 85
b5d4d3b9 86[ List each enhancement as a =item entry ]
60dde9d3 87
b5d4d3b9 88=over 4
f348c3d8 89
6ed80d55 90=item *
f348c3d8 91
b5d4d3b9 92XXX
cd3802ac 93
b5d4d3b9 94=back
cd3802ac 95
b5d4d3b9 96=head1 Modules and Pragmata
d6c13051 97
b5d4d3b9
MM
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.
02a0bddf 103
b5d4d3b9 104[ Within each section, list entries as a =item entry ]
128f4e12 105
b5d4d3b9 106=head2 New Modules and Pragmata
cd3802ac 107
b5d4d3b9 108=over 4
60dde9d3
MM
109
110=item *
111
b5d4d3b9 112XXX
3aba4f3d 113
b5d4d3b9 114=back
af292847 115
b5d4d3b9 116=head2 Updated Modules and Pragmata
190f5bb6 117
b5d4d3b9 118=over 4
b045b8b5
TC
119
120=item *
121
b5d4d3b9 122L<XXX> has been upgraded from version A.xx to B.yy.
190f5bb6 123
b5d4d3b9 124=back
ba31029d 125
b5d4d3b9 126=head2 Removed Modules and Pragmata
b045b8b5 127
b5d4d3b9 128=over 4
aa67537d 129
4c7a0d98
DD
130=item *
131
b5d4d3b9 132XXX
4c7a0d98 133
b5d4d3b9 134=back
4c7a0d98 135
b5d4d3b9 136=head1 Documentation
f4eedc6b 137
b5d4d3b9
MM
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>.
f4eedc6b 140
b5d4d3b9 141=head2 New Documentation
6ed80d55 142
b5d4d3b9 143XXX Changes which create B<new> files in F<pod/> go here.
f348c3d8 144
b5d4d3b9 145=head3 L<XXX>
f348c3d8 146
b5d4d3b9 147XXX Description of the purpose of the new file here
f348c3d8 148
b5d4d3b9 149=head2 Changes to Existing Documentation
f348c3d8 150
b5d4d3b9
MM
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.
f348c3d8 154
b5d4d3b9 155=head3 L<XXX>
f348c3d8 156
b5d4d3b9 157=over 4
6ed80d55 158
60dde9d3 159=item *
f348c3d8 160
b5d4d3b9 161XXX Description of the change here
4dc623f0 162
b5d4d3b9 163=back
84d03adf 164
b5d4d3b9 165=head1 Diagnostics
ff433f2d 166
b5d4d3b9
MM
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>.
4cd408ba 170
b5d4d3b9
MM
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.
6ed80d55 173
b5d4d3b9 174=head2 New Diagnostics
6ed80d55 175
b5d4d3b9
MM
176XXX Newly added diagnostic messages go under here, separated into New Errors
177and New Warnings
6ed80d55 178
b5d4d3b9 179=head3 New Errors
f348c3d8 180
b5d4d3b9 181=over 4
ab0b796c 182
60dde9d3 183=item *
8c6180a9 184
b5d4d3b9 185XXX L<message|perldiag/"message">
8c6180a9 186
b5d4d3b9 187=back
0561e60b 188
b5d4d3b9 189=head3 New Warnings
dd200dff 190
b5d4d3b9 191=over 4
dd200dff 192
73e793fc
FC
193=item *
194
b5d4d3b9 195XXX L<message|perldiag/"message">
73e793fc 196
b5d4d3b9 197=back
8c6180a9 198
b5d4d3b9 199=head2 Changes to Existing Diagnostics
0561e60b 200
b5d4d3b9 201XXX Changes (i.e. rewording) of diagnostic messages go here
4a328228 202
b5d4d3b9 203=over 4
4cd408ba 204
1861205d
FC
205=item *
206
b5d4d3b9 207XXX Describe change here
1861205d 208
b5d4d3b9 209=back
40a81b59 210
b5d4d3b9 211=head1 Utility Changes
2a395b86 212
b5d4d3b9
MM
213XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here.
214Most of these are built within the directory F<utils>.
2a395b86 215
b5d4d3b9
MM
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. ]
12d22d1f 219
b5d4d3b9 220=head2 L<XXX>
2a395b86 221
b5d4d3b9 222=over 4
2a395b86
PM
223
224=item *
225
b5d4d3b9 226XXX
bb8c7e27 227
b5d4d3b9 228=back
bb8c7e27 229
b5d4d3b9 230=head1 Configuration and Compilation
bb8c7e27 231
b5d4d3b9
MM
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.
aa292ef2 236
b5d4d3b9 237[ List changes as a =item entry ].
83b69bfd 238
b5d4d3b9 239=over 4
83b69bfd
DD
240
241=item *
242
b5d4d3b9 243XXX
13adb056 244
b5d4d3b9 245=back
391823f2 246
b5d4d3b9 247=head1 Testing
6ff8f256 248
b5d4d3b9
MM
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.
80cc3290 254
b5d4d3b9 255[ List each test improvement as a =item entry ]
60dde9d3 256
b5d4d3b9 257=over 4
db98db4e 258
8818afe8
TC
259=item *
260
b5d4d3b9 261XXX
9d22ccf6 262
b5d4d3b9 263=back
480961b6 264
b5d4d3b9 265=head1 Platform Support
480961b6 266
b5d4d3b9 267XXX Any changes to platform support should be listed in the sections below.
94c9bf90 268
b5d4d3b9
MM
269[ Within the sections, list each platform as a =item entry with specific
270changes as paragraphs below it. ]
94c9bf90 271
b5d4d3b9 272=head2 New Platforms
8af808bf 273
b5d4d3b9
MM
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.
8af808bf 278
b5d4d3b9 279=over 4
fdcaecb7 280
b5d4d3b9 281=item XXX-some-platform
fdcaecb7 282
b5d4d3b9 283XXX
2af7c6b6 284
4dc623f0 285=back
2af7c6b6 286
b5d4d3b9 287=head2 Discontinued Platforms
60dde9d3 288
b5d4d3b9 289XXX List any platforms that this version of perl no longer compiles on.
c0b32823 290
4dc623f0 291=over 4
b1a4e8b3 292
b5d4d3b9 293=item XXX-some-platform
b1a4e8b3 294
b5d4d3b9 295XXX
9e26817d 296
4dc623f0 297=back
9e26817d 298
4dc623f0 299=head2 Platform-Specific Notes
70cee83f 300
b5d4d3b9
MM
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.
70cee83f 305
b5d4d3b9 306=over 4
e5fbfbc1 307
b5d4d3b9 308=item XXX-some-platform
e5fbfbc1 309
b5d4d3b9 310XXX
353075a0 311
4dc623f0 312=back
353075a0 313
4dc623f0 314=head1 Internal Changes
9f122eef 315
b5d4d3b9
MM
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.
bd2aa467 319
b5d4d3b9 320[ List each change as a =item entry ]
2ec11c70 321
b5d4d3b9 322=over 4
2ec11c70
DM
323
324=item *
325
b5d4d3b9 326XXX
2ec11c70 327
4dc623f0 328=back
c7f058f0 329
4dc623f0 330=head1 Selected Bug Fixes
0ef4323a 331
b5d4d3b9
MM
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>.
279aef25 334
b5d4d3b9 335[ List each fix as a =item entry ]
00ba25b8 336
b5d4d3b9 337=over 4
00ba25b8 338
567291b6
FC
339=item *
340
b5d4d3b9 341XXX
fcfb7b86 342
b5d4d3b9 343=back
fcfb7b86 344
b5d4d3b9 345=head1 Known Problems
8bb83ec2 346
b5d4d3b9
MM
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.
8bb83ec2 350
b5d4d3b9 351[ List each fix as a =item entry ]
1318b6d7 352
b5d4d3b9 353=over 4
1318b6d7 354
6f67fbfe
FC
355=item *
356
b5d4d3b9 357XXX
070733df 358
b5d4d3b9 359=back
219f8441 360
b5d4d3b9 361=head1 Errata From Previous Releases
219f8441 362
b5d4d3b9 363=over 4
5747f88b 364
61a8c397
FC
365=item *
366
b5d4d3b9
MM
367XXX Add anything here that we forgot to add, or were mistaken about, in
368the perldelta of a previous release.
61a8c397 369
86372193 370=back
bb8c7e27 371
b5d4d3b9 372=head1 Obituary
3a085d00 373
b5d4d3b9
MM
374XXX If any significant core contributor has died, we've added a short obituary
375here.
01d42a22 376
b5d4d3b9 377=head1 Acknowledgements
01d42a22 378
b5d4d3b9 379XXX Generate this with:
01d42a22 380
b5d4d3b9 381 perl Porting/acknowledgements.pl v5.21.7..HEAD
f5b73711 382
44691e6f
AB
383=head1 Reporting Bugs
384
e08634c5
SH
385If you find what you think is a bug, you might check the articles recently
386posted to the comp.lang.perl.misc newsgroup and the perl bug database at
238894db 387https://rt.perl.org/ . There may also be information at
7ef8b31d 388http://www.perl.org/ , the Perl Home Page.
44691e6f 389
e08634c5
SH
390If you believe you have an unreported bug, please run the L<perlbug> program
391included with your release. Be sure to trim your bug down to a tiny but
392sufficient test case. Your bug report, along with the output of C<perl -V>,
393will be sent off to perlbug@perl.org to be analysed by the Perl porting team.
44691e6f
AB
394
395If the bug you are reporting has security implications, which make it
e08634c5
SH
396inappropriate to send to a publicly archived mailing list, then please send it
397to perl5-security-report@perl.org. This points to a closed subscription
398unarchived mailing list, which includes all the core committers, who will be
399able to help assess the impact of issues, figure out a resolution, and help
f9001595 400co-ordinate the release of patches to mitigate or fix the problem across all
e08634c5
SH
401platforms on which Perl is supported. Please only use this address for
402security issues in the Perl core, not for modules independently distributed on
403CPAN.
44691e6f
AB
404
405=head1 SEE ALSO
406
e08634c5
SH
407The F<Changes> file for an explanation of how to view exhaustive details on
408what changed.
44691e6f
AB
409
410The F<INSTALL> file for how to build Perl.
411
412The F<README> file for general stuff.
413
414The F<Artistic> and F<Copying> files for copyright information.
415
416=cut