This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
t/porting/authors.t can send just the git log info needed by checkAUTHORS.pl
[perl5.git] / pod / perldelta.pod
CommitLineData
44691e6f
AB
1=encoding utf8
2
3=head1 NAME
4
e3c71926
FR
5[ this is a template for a new perldelta file. Any text flagged as
6XXX needs to be processed before release. ]
7
8perldelta - what is new for perl v5.15.5
760696b8 9
5438d4b8 10=head1 DESCRIPTION
5cd408a2 11
e3c71926
FR
12This document describes differences between the 5.15.4 release and
13the 5.15.5 release.
5cd408a2 14
3432e5a1 15If you are upgrading from an earlier release such as 5.15.3, first read
e3c71926 16L<perl5154delta>, which describes differences between 5.15.3 and
3432e5a1 175.15.4.
062678b2 18
e3c71926 19=head1 Notice
d2006265 20
e3c71926 21XXX Any important notices here
3f728e2e 22
e3c71926 23=head1 Core Enhancements
6d110ad0 24
e3c71926
FR
25XXX New core language features go here. Summarise user-visible core language
26enhancements. Particularly prominent performance optimisations could go
27here, but most should go in the L</Performance Enhancements> section.
6d110ad0 28
e3c71926 29[ List each enhancement as a =head2 entry ]
6d110ad0 30
e3c71926 31=head1 Security
6d110ad0 32
e3c71926
FR
33XXX Any security-related notices go here. In particular, any security
34vulnerabilities closed should be noted here rather than in the
35L</Selected Bug Fixes> section.
6d110ad0 36
e3c71926 37[ List each security issue as a =head2 entry ]
6d110ad0 38
e3c71926 39=head1 Incompatible Changes
6d110ad0 40
e3c71926 41XXX For a release on a stable branch, this section aspires to be:
6d110ad0 42
e3c71926
FR
43 There are no changes intentionally incompatible with 5.XXX.XXX
44 If any exist, they are bugs and reports are welcome.
6d110ad0 45
e3c71926 46[ List each incompatible change as a =head2 entry ]
6d110ad0 47
e3c71926 48=head1 Deprecations
6d110ad0 49
e3c71926
FR
50XXX Any deprecated features, syntax, modules etc. should be listed here.
51In particular, deprecated modules should be listed here even if they are
52listed as an updated module in the L</Modules and Pragmata> section.
6d110ad0 53
e3c71926 54[ List each deprecation as a =head2 entry ]
6d110ad0 55
e3c71926 56=head1 Performance Enhancements
6d110ad0 57
e3c71926
FR
58XXX Changes which enhance performance without changing behaviour go here. There
59may well be none in a stable release.
6d110ad0 60
e3c71926 61[ List each enhancement as a =item entry ]
6d110ad0 62
e3c71926 63=over 4
6d110ad0
FC
64
65=item *
66
e3c71926 67XXX
6d110ad0 68
e3c71926 69=back
6d110ad0 70
e3c71926 71=head1 Modules and Pragmata
6d110ad0 72
e3c71926
FR
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.
6d110ad0 80
e3c71926 81[ Within each section, list entries as a =item entry ]
6d110ad0 82
e3c71926 83=head2 New Modules and Pragmata
6d110ad0 84
e3c71926 85=over 4
6d110ad0
FC
86
87=item *
88
e3c71926 89XXX
6d110ad0
FC
90
91=back
92
e3c71926 93=head2 Updated Modules and Pragmata
6d110ad0 94
e3c71926 95=over 4
6d110ad0
FC
96
97=item *
98
ac73ea1e
CBW
99L<Archive::Extract> has been upgraded from version 0.56 to version 0.58.
100
101=item *
102
aba0546e
CBW
103L<CPANPLUS::Dist::Build> has been upgraded from version 0.58 to version 0.60.
104
105=item *
106
00441cfa
CBW
107L<ExtUtils::MakeMaker> has been upgraded from version 6.61_01 to version 6.63_01.
108
109=item *
110
6ce52845 111L<HTTP::Tiny> has been upgraded from version 0.013 to version 0.016.
35265876
CBW
112
113Adds additional shorthand methods for all common HTTP verbs,
114a C<post_form()> method for POST-ing x-www-form-urlencoded data and
115a C<www_form_urlencode()> utility method.
6d110ad0 116
be539103
CBW
117=item *
118
119L<perlfaq> has been upgraded from version 5.0150035 to version 5.0150036.
120
a47fb3fe
CBW
121=item *
122
123L<Unicode::Collate> has been upgraded from version 0.80 to version 0.81.
124
125Locales updated to CLDR 2.0: mk, mt, nb, nn, ro, ru.
126Newly supported locales: ml, mr, or, pa.
127
e3c71926 128=back
6d110ad0 129
e3c71926 130=head2 Removed Modules and Pragmata
6d110ad0 131
e3c71926 132=over 4
6d110ad0
FC
133
134=item *
135
e3c71926 136XXX
6d110ad0 137
e3c71926 138=back
6d110ad0 139
e3c71926 140=head1 Documentation
6d110ad0 141
e3c71926
FR
142XXX Changes to files in F<pod/> go here. Consider grouping entries by
143file and be sure to link to the appropriate page, e.g. L<perlfunc>.
6d110ad0 144
e3c71926 145=head2 New Documentation
6d110ad0 146
e3c71926 147XXX Changes which create B<new> files in F<pod/> go here.
6d110ad0 148
e3c71926 149=head3 L<XXX>
6d110ad0 150
e3c71926 151XXX Description of the purpose of the new file here
6d110ad0 152
e3c71926 153=head2 Changes to Existing Documentation
6d110ad0 154
e3c71926
FR
155XXX Changes which significantly change existing files in F<pod/> go here.
156However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
157section.
6d110ad0 158
e3c71926
FR
159=head3 L<XXX>
160
161=over 4
6d110ad0
FC
162
163=item *
164
e3c71926 165XXX Description of the change here
6d110ad0
FC
166
167=back
168
e3c71926
FR
169=head1 Diagnostics
170
171The following additions or changes have been made to diagnostic output,
172including warnings and fatal error messages. For the complete list of
173diagnostic messages, see L<perldiag>.
6d110ad0 174
e3c71926
FR
175XXX New or changed warnings emitted by the core's C<C> code go here. Also
176include any changes in L<perldiag> that reconcile it to the C<C> code.
b53e16ae 177
e3c71926
FR
178[ Within each section, list entries as a =item entry that links to perldiag,
179 e.g.
b53e16ae 180
e3c71926 181 =item *
b53e16ae 182
e3c71926
FR
183 L<Invalid version object|perldiag/"Invalid version object">
184]
46dd4080 185
e3c71926 186=head2 New Diagnostics
46dd4080 187
e3c71926 188XXX Newly added diagnostic messages go here
46dd4080 189
e3c71926 190=head3 New Errors
d6cf2367 191
63ac71b9 192=over 4
e46d9735
CBW
193
194=item *
195
e3c71926 196XXX L<message|perldiag/"message">
828d6195 197
3432e5a1 198=back
83307084 199
e3c71926 200=head3 New Warnings
d39de893 201
3432e5a1 202=over 4
39afdc5a
CBW
203
204=item *
205
e3c71926 206XXX L<message|perldiag/"message">
666c7ca6 207
e3c71926 208=back
7b8e5ef0 209
e3c71926 210=head2 Changes to Existing Diagnostics
91710846 211
e3c71926 212XXX Changes (i.e. rewording) of diagnostic messages go here
91710846 213
e3c71926 214=over 4
91710846
DG
215
216=item *
217
e3c71926 218XXX Describe change here
a2fa999d 219
e3c71926 220=back
a2fa999d 221
e3c71926 222=head1 Utility Changes
19e72bbf 223
e3c71926
FR
224XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go
225here. Most of these are built within the directories F<utils> and F<x2p>.
19e72bbf 226
e3c71926
FR
227[ List utility changes as a =head3 entry for each utility and =item
228entries for each change
229Use L<XXX> with program names to get proper documentation linking. ]
19e72bbf 230
e3c71926 231=head3 L<XXX>
bd65daab 232
e3c71926 233=over 4
bd65daab 234
3f2cb5bf
SM
235=item *
236
e3c71926 237XXX
f0381222 238
e3c71926 239=back
f0381222 240
e3c71926 241=head1 Configuration and Compilation
02e7ec6d 242
e3c71926
FR
243XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
244go here. Any other changes to the Perl build process should be listed here.
245However, any platform-specific changes should be listed in the
246L</Platform Support> section, instead.
02e7ec6d 247
e3c71926 248[ List changes as a =item entry ].
02e7ec6d 249
e3c71926 250=over 4
1e915955
CBW
251
252=item *
253
e3c71926 254XXX
3f2cb5bf 255
3432e5a1 256=back
666c7ca6 257
e3c71926 258=head1 Testing
8fe353ef 259
e3c71926
FR
260XXX Any significant changes to the testing of a freshly built perl should be
261listed here. Changes which create B<new> files in F<t/> go here as do any
262large changes to the testing harness (e.g. when parallel testing was added).
263Changes to existing files in F<t/> aren't worth summarising, although the bugs
264that they represent may be covered elsewhere.
7ac26854 265
e3c71926 266[ List each test improvement as a =item entry ]
daef35db 267
3432e5a1 268=over 4
83307084
SL
269
270=item *
271
e3c71926 272XXX
b420b12a 273
3432e5a1 274=back
b420b12a 275
e3c71926 276=head1 Platform Support
b53e16ae 277
e3c71926 278XXX Any changes to platform support should be listed in the sections below.
9eb1e3e2 279
e3c71926
FR
280[ Within the sections, list each platform as a =item entry with specific
281changes as paragraphs below it. ]
9eb1e3e2 282
e3c71926 283=head2 New Platforms
b53e16ae 284
e3c71926
FR
285XXX List any platforms that this version of perl compiles on, that previous
286versions did not. These will either be enabled by new files in the F<hints/>
287directories, or new subdirectories and F<README> files at the top level of the
288source tree.
b53e16ae
FC
289
290=over 4
291
e3c71926 292=item XXX-some-platform
b53e16ae 293
e3c71926 294XXX
b53e16ae
FC
295
296=back
297
e3c71926 298=head2 Discontinued Platforms
83307084 299
e3c71926 300XXX List any platforms that this version of perl no longer compiles on.
3432e5a1 301
d6cf2367
FC
302=over 4
303
e3c71926 304=item XXX-some-platform
d6cf2367 305
e3c71926 306XXX
c634fdd3 307
3432e5a1 308=back
9cfd094e 309
e3c71926
FR
310=head2 Platform-Specific Notes
311
312XXX List any changes for specific platforms. This could include configuration
313and compilation changes or changes in portability/compatibility. However,
314changes within modules for platforms should generally be listed in the
315L</Modules and Pragmata> section.
9cfd094e 316
3432e5a1 317=over 4
95f7e41f 318
e3c71926 319=item XXX-some-platform
95f7e41f 320
e3c71926 321XXX
df5b44bd 322
63ac71b9 323=back
310913d4 324
3432e5a1 325=head1 Internal Changes
d6cf2367 326
e3c71926
FR
327XXX Changes which affect the interface available to C<XS> code go here.
328Other significant internal changes for future core maintainers should
329be noted as well.
5d4ff231 330
e3c71926 331[ List each change as a =item entry ]
6d110ad0 332
e3c71926 333=over 4
b53e16ae
FC
334
335=item *
336
e3c71926 337XXX
b53e16ae 338
3432e5a1 339=back
60092ce4 340
3432e5a1 341=head1 Selected Bug Fixes
309aab3a 342
e3c71926
FR
343XXX Important bug fixes in the core language are summarised here.
344Bug fixes in files in F<ext/> and F<lib/> are best summarised in
345L</Modules and Pragmata>.
19e72bbf 346
e3c71926 347[ List each fix as a =item entry ]
19e72bbf 348
e3c71926 349=over 4
b53e16ae
FC
350
351=item *
352
e3c71926 353XXX
ca955add 354
e3c71926 355=back
ca955add 356
e3c71926 357=head1 Known Problems
b53e16ae 358
e3c71926
FR
359XXX Descriptions of platform agnostic bugs we know we can't fix go here. Any
360tests that had to be C<TODO>ed for the release would be noted here, unless
361they were specific to a particular platform (see below).
b53e16ae 362
e3c71926
FR
363This is a list of some significant unfixed bugs, which are regressions
364from either 5.XXX.XXX or 5.XXX.XXX.
b53e16ae 365
e3c71926 366[ List each fix as a =item entry ]
b53e16ae 367
e3c71926 368=over 4
b53e16ae
FC
369
370=item *
371
e3c71926 372XXX
b53e16ae 373
63ac71b9 374=back
bbc28bfc 375
e3c71926 376=head1 Obituary
a777c865 377
e3c71926
FR
378XXX If any significant core contributor has died, we've added a short obituary
379here.
a777c865 380
e3c71926 381=head1 Acknowledgements
a777c865 382
e3c71926 383XXX Generate this with:
a777c865 384
e3c71926 385 perl Porting/acknowledgements.pl v5.15.4..HEAD
29cf780c 386
44691e6f
AB
387=head1 Reporting Bugs
388
389If you find what you think is a bug, you might check the articles
34dc2ec0 390recently posted to the comp.lang.perl.misc newsgroup and the perl
44691e6f
AB
391bug database at http://rt.perl.org/perlbug/ . There may also be
392information at http://www.perl.org/ , the Perl Home Page.
393
394If you believe you have an unreported bug, please run the L<perlbug>
395program included with your release. Be sure to trim your bug down
396to a tiny but sufficient test case. Your bug report, along with the
397output of C<perl -V>, will be sent off to perlbug@perl.org to be
398analysed by the Perl porting team.
399
400If the bug you are reporting has security implications, which make it
401inappropriate to send to a publicly archived mailing list, then please send
34dc2ec0 402it to perl5-security-report@perl.org. This points to a closed subscription
b4707b2a
FC
403unarchived mailing list, which includes
404all the core committers, who will be able
44691e6f
AB
405to help assess the impact of issues, figure out a resolution, and help
406co-ordinate the release of patches to mitigate or fix the problem across all
34dc2ec0
DM
407platforms on which Perl is supported. Please only use this address for
408security issues in the Perl core, not for modules independently
44691e6f
AB
409distributed on CPAN.
410
411=head1 SEE ALSO
412
413The F<Changes> file for an explanation of how to view exhaustive details
414on what changed.
415
416The F<INSTALL> file for how to build Perl.
417
418The F<README> file for general stuff.
419
420The F<Artistic> and F<Copying> files for copyright information.
421
422=cut