This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
perldelta for 92fd341d6
[perl5.git] / pod / perldelta.pod
CommitLineData
44691e6f
AB
1=encoding utf8
2
3=head1 NAME
4
337fb649
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.17.11
e128ab2c 9
4eabcf70 10=head1 DESCRIPTION
6db9054f 11
337fb649 12This document describes differences between the 5.17.10 release and the 5.17.11
e08634c5 13release.
6db9054f 14
337fb649
MM
15If you are upgrading from an earlier release such as 5.17.9, first read
16L<perl51710delta>, which describes differences between 5.17.9 and 5.17.10.
3f01b192 17
337fb649 18=head1 Notice
3f01b192 19
337fb649 20XXX Any important notices here
3f01b192 21
337fb649 22=head1 Core Enhancements
3f01b192 23
337fb649
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.
3f01b192 27
337fb649 28[ List each enhancement as a =head2 entry ]
32833930 29
337fb649 30=head1 Security
32833930 31
337fb649
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.
3f01b192 35
337fb649 36[ List each security issue as a =head2 entry ]
3f01b192 37
337fb649 38=head1 Incompatible Changes
3f01b192 39
337fb649 40XXX For a release on a stable branch, this section aspires to be:
d7a08570 41
337fb649
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.
d7a08570 45
337fb649 46[ List each incompatible change as a =head2 entry ]
3f01b192 47
337fb649 48=head1 Deprecations
751611d4 49
337fb649
MM
50XXX Any deprecated features, syntax, modules etc. should be listed here. In
51particular, deprecated modules should be listed here even if they are listed as
52an updated module in the L</Modules and Pragmata> section.
751611d4 53
337fb649 54[ List each deprecation as a =head2 entry ]
751611d4 55
337fb649 56=head1 Performance Enhancements
751611d4 57
337fb649
MM
58XXX Changes which enhance performance without changing behaviour go here.
59There may well be none in a stable release.
86148eee 60
337fb649 61[ List each enhancement as a =item entry ]
19718730
AC
62
63=over 4
7a7a10c7 64
e14ac59b 65=item *
7a7a10c7 66
337fb649 67XXX
82d98f72 68
337fb649 69=back
82d98f72 70
337fb649 71=head1 Modules and Pragmata
82d98f72 72
337fb649
MM
73XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
74go here. If Module::CoreList is updated, generate an initial draft of the
75following sections using F<Porting/corelist-perldelta.pl>, which prints stub
76entries to STDOUT. Results can be pasted in place of the '=head2' entries
77below. A paragraph summary for important changes should then be added by hand.
78In an ideal world, dual-life modules would have a F<Changes> file that could be
79cribbed.
82d98f72 80
337fb649 81[ Within each section, list entries as a =item entry ]
82d98f72 82
337fb649 83=head2 New Modules and Pragmata
82d98f72 84
337fb649 85=over 4
82d98f72
MM
86
87=item *
88
337fb649 89XXX
a2656c4a 90
337fb649 91=back
2426c394 92
337fb649 93=head2 Updated Modules and Pragmata
14731ad1 94
337fb649 95=over 4
14731ad1 96
82d98f72 97=item *
14731ad1 98
829397b9
TC
99Fixed the merge of ExtUtils-MakeMaker 6.65_01 to remove an excluded
100file. This was causing a test failure on Win32 [perl #117477]
101
102=item *
103
337fb649 104L<XXX> has been upgraded from version A.xx to B.yy.
2426c394 105
337fb649 106=back
2426c394 107
337fb649 108=head2 Removed Modules and Pragmata
82d98f72 109
337fb649 110=over 4
2426c394
CBW
111
112=item *
113
337fb649 114XXX
2426c394 115
337fb649 116=back
2426c394 117
337fb649 118=head1 Documentation
2426c394 119
337fb649
MM
120XXX Changes to files in F<pod/> go here. Consider grouping entries by
121file and be sure to link to the appropriate page, e.g. L<perlfunc>.
2426c394 122
337fb649 123=head2 New Documentation
2426c394 124
337fb649 125XXX Changes which create B<new> files in F<pod/> go here.
2426c394 126
337fb649 127=head3 L<XXX>
2426c394 128
337fb649 129XXX Description of the purpose of the new file here
2426c394 130
337fb649 131=head2 Changes to Existing Documentation
2426c394 132
337fb649
MM
133XXX Changes which significantly change existing files in F<pod/> go here.
134However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
135section.
2426c394 136
337fb649 137=head3 L<XXX>
2426c394 138
337fb649 139=over 4
2426c394 140
82d98f72 141=item *
e58c5aaf 142
337fb649 143XXX Description of the change here
2426c394 144
337fb649 145=back
2426c394 146
337fb649 147=head1 Diagnostics
2426c394 148
337fb649
MM
149The following additions or changes have been made to diagnostic output,
150including warnings and fatal error messages. For the complete list of
151diagnostic messages, see L<perldiag>.
2426c394 152
337fb649
MM
153XXX New or changed warnings emitted by the core's C<C> code go here. Also
154include any changes in L<perldiag> that reconcile it to the C<C> code.
2426c394 155
337fb649 156=head2 New Diagnostics
2426c394 157
337fb649
MM
158XXX Newly added diagnostic messages go under here, separated into New Errors
159and New Warnings
2426c394 160
337fb649 161=head3 New Errors
2426c394 162
337fb649 163=over 4
2426c394 164
82d98f72 165=item *
2426c394 166
337fb649 167XXX L<message|perldiag/"message">
82d98f72 168
337fb649 169=back
2426c394 170
337fb649 171=head3 New Warnings
2426c394 172
337fb649 173=over 4
982110e0 174
82d98f72 175=item *
2426c394 176
33392251
BF
177L<Smartmatch is experimental|perldiag/"Smartmatch is experimental">
178
179=item *
180
181L<given is experimental|perldiag/"given is experimental">
182
183=item *
184
185L<when is experimental|perldiag/"when is experimental">
2426c394 186
337fb649 187=back
2426c394 188
337fb649 189=head2 Changes to Existing Diagnostics
2426c394 190
337fb649 191XXX Changes (i.e. rewording) of diagnostic messages go here
ff683671 192
337fb649 193=over 4
2426c394 194
82d98f72 195=item *
2426c394 196
337fb649 197XXX Describe change here
2426c394 198
337fb649 199=back
2426c394 200
337fb649 201=head1 Utility Changes
2426c394 202
337fb649
MM
203XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here.
204Most of these are built within the directories F<utils> and F<x2p>.
2426c394 205
337fb649
MM
206[ List utility changes as a =head3 entry for each utility and =item
207entries for each change
208Use L<XXX> with program names to get proper documentation linking. ]
2426c394 209
337fb649 210=head3 L<XXX>
2426c394 211
337fb649 212=over 4
2426c394 213
82d98f72
MM
214=item *
215
337fb649 216XXX
82d98f72 217
337fb649 218=back
19718730 219
337fb649 220=head1 Configuration and Compilation
19718730 221
337fb649
MM
222XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
223go here. Any other changes to the Perl build process should be listed here.
224However, any platform-specific changes should be listed in the
225L</Platform Support> section, instead.
dd4b1c75 226
337fb649 227[ List changes as a =item entry ].
dd4b1c75 228
337fb649 229=over 4
cb077ed2 230
82d98f72 231=item *
5f877a7f 232
337fb649 233XXX
1ea91bbe 234
337fb649 235=back
19718730 236
337fb649 237=head1 Testing
82d98f72 238
337fb649
MM
239XXX Any significant changes to the testing of a freshly built perl should be
240listed here. Changes which create B<new> files in F<t/> go here as do any
241large changes to the testing harness (e.g. when parallel testing was added).
242Changes to existing files in F<t/> aren't worth summarizing, although the bugs
243that they represent may be covered elsewhere.
5e0a247b 244
337fb649 245[ List each test improvement as a =item entry ]
5e0a247b 246
337fb649 247=over 4
19718730 248
82d98f72 249=item *
19718730 250
337fb649 251XXX
8b877d20 252
337fb649 253=back
19718730 254
337fb649 255=head1 Platform Support
19718730 256
337fb649 257XXX Any changes to platform support should be listed in the sections below.
19718730 258
337fb649
MM
259[ Within the sections, list each platform as a =item entry with specific
260changes as paragraphs below it. ]
19718730 261
337fb649 262=head2 New Platforms
e078d89d 263
337fb649
MM
264XXX List any platforms that this version of perl compiles on, that previous
265versions did not. These will either be enabled by new files in the F<hints/>
266directories, or new subdirectories and F<README> files at the top level of the
267source tree.
82d98f72 268
337fb649 269=over 4
09a49503 270
337fb649 271=item XXX-some-platform
82d98f72 272
337fb649 273XXX
82d98f72 274
337fb649 275=back
82d98f72 276
337fb649 277=head2 Discontinued Platforms
82d98f72 278
337fb649 279XXX List any platforms that this version of perl no longer compiles on.
82d98f72 280
337fb649 281=over 4
82d98f72 282
337fb649 283=item XXX-some-platform
82d98f72 284
337fb649 285XXX
09a49503 286
6253ee75 287=back
e078d89d 288
337fb649 289=head2 Platform-Specific Notes
82d98f72 290
337fb649
MM
291XXX List any changes for specific platforms. This could include configuration
292and compilation changes or changes in portability/compatibility. However,
293changes within modules for platforms should generally be listed in the
294L</Modules and Pragmata> section.
e078d89d 295
5a6a30f4 296=over 4
b7c7d786 297
337fb649 298=item XXX-some-platform
d2d1e842 299
337fb649 300XXX
d2d1e842 301
5a6a30f4 302=back
d2d1e842 303
337fb649 304=head1 Internal Changes
d2d1e842 305
337fb649
MM
306XXX Changes which affect the interface available to C<XS> code go here. Other
307significant internal changes for future core maintainers should be noted as
308well.
82d98f72 309
337fb649 310[ List each change as a =item entry ]
d2d1e842 311
5a6a30f4 312=over 4
b9214e65 313
82d98f72 314=item *
b9214e65 315
337fb649 316XXX
f355e93d 317
5a6a30f4 318=back
f355e93d 319
337fb649 320=head1 Selected Bug Fixes
19718730 321
337fb649
MM
322XXX Important bug fixes in the core language are summarized here. Bug fixes in
323files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>.
19718730 324
337fb649 325[ List each fix as a =item entry ]
19718730 326
19718730 327=over 4
e14ac59b 328
fdea6f98
FC
329=item *
330
337fb649 331XXX
9f351b45 332
337fb649 333=back
9f351b45 334
337fb649 335=head1 Known Problems
9f351b45 336
337fb649
MM
337XXX Descriptions of platform agnostic bugs we know we can't fix go here. Any
338tests that had to be C<TODO>ed for the release would be noted here. Unfixed
339platform specific bugs also go here.
7cf3104f 340
337fb649 341[ List each fix as a =item entry ]
8a987e1a 342
6253ee75 343=over 4
f5778209 344
216cf7fc
DR
345=item *
346
337fb649 347XXX
12719193 348
6253ee75 349=back
216cf7fc 350
337fb649
MM
351=head1 Obituary
352
353XXX If any significant core contributor has died, we've added a short obituary
354here.
355
19718730 356=head1 Acknowledgements
f5b73711 357
337fb649
MM
358XXX Generate this with:
359
360 perl Porting/acknowledgements.pl v5.17.10..HEAD
f5b73711 361
44691e6f
AB
362=head1 Reporting Bugs
363
e08634c5
SH
364If you find what you think is a bug, you might check the articles recently
365posted to the comp.lang.perl.misc newsgroup and the perl bug database at
366http://rt.perl.org/perlbug/ . There may also be information at
367http://www.perl.org/ , the Perl Home Page.
44691e6f 368
e08634c5
SH
369If you believe you have an unreported bug, please run the L<perlbug> program
370included with your release. Be sure to trim your bug down to a tiny but
371sufficient test case. Your bug report, along with the output of C<perl -V>,
372will be sent off to perlbug@perl.org to be analysed by the Perl porting team.
44691e6f
AB
373
374If the bug you are reporting has security implications, which make it
e08634c5
SH
375inappropriate to send to a publicly archived mailing list, then please send it
376to perl5-security-report@perl.org. This points to a closed subscription
377unarchived mailing list, which includes all the core committers, who will be
378able to help assess the impact of issues, figure out a resolution, and help
f9001595 379co-ordinate the release of patches to mitigate or fix the problem across all
e08634c5
SH
380platforms on which Perl is supported. Please only use this address for
381security issues in the Perl core, not for modules independently distributed on
382CPAN.
44691e6f
AB
383
384=head1 SEE ALSO
385
e08634c5
SH
386The F<Changes> file for an explanation of how to view exhaustive details on
387what changed.
44691e6f
AB
388
389The F<INSTALL> file for how to build Perl.
390
391The F<README> file for general stuff.
392
393The F<Artistic> and F<Copying> files for copyright information.
394
395=cut