This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Merge branch 'dual-life-socket' into blead
[perl5.git] / pod / perldelta.pod
CommitLineData
44691e6f
AB
1=encoding utf8
2
3=head1 NAME
4
0aaeb177
SH
5[ this is a template for a new perldelta file. Any text flagged as
6XXX needs to be processed before release. ]
760696b8 7
0aaeb177 8perldelta - what is new for perl v5.15.6
062678b2 9
0aaeb177 10=head1 DESCRIPTION
ad32999b 11
0aaeb177
SH
12This document describes differences between the 5.15.5 release and
13the 5.15.6 release.
ad32999b 14
0aaeb177
SH
15If you are upgrading from an earlier release such as 5.15.4, first read
16L<perl5155delta>, which describes differences between 5.15.4 and
175.15.5.
ad32999b 18
0aaeb177 19=head1 Notice
ad32999b 20
0aaeb177 21XXX Any important notices here
ad32999b 22
0aaeb177 23=head1 Core Enhancements
a3f52e2e 24
0aaeb177
SH
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.
a3f52e2e 28
0aaeb177 29[ List each enhancement as a =head2 entry ]
6d110ad0 30
e3c71926 31=head1 Security
6d110ad0 32
0aaeb177
SH
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
0aaeb177 37[ List each security issue as a =head2 entry ]
6d110ad0 38
e3c71926 39=head1 Incompatible Changes
6d110ad0 40
0aaeb177 41XXX For a release on a stable branch, this section aspires to be:
ad32999b 42
0aaeb177
SH
43 There are no changes intentionally incompatible with 5.XXX.XXX
44 If any exist, they are bugs and reports are welcome.
ad32999b 45
0aaeb177 46[ List each incompatible change as a =head2 entry ]
ad32999b 47
e3c71926 48=head1 Deprecations
6d110ad0 49
0aaeb177
SH
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.
ae92a9ae 53
0aaeb177 54[ List each deprecation as a =head2 entry ]
ae92a9ae 55
e3c71926 56=head1 Performance Enhancements
6d110ad0 57
0aaeb177
SH
58XXX Changes which enhance performance without changing behaviour go here. There
59may well be none in a stable release.
60
61[ List each enhancement as a =item entry ]
62
e3c71926 63=over 4
6d110ad0
FC
64
65=item *
66
0aaeb177 67XXX
6d110ad0 68
e3c71926 69=back
6d110ad0 70
e3c71926 71=head1 Modules and Pragmata
6d110ad0 72
0aaeb177
SH
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.
80
81[ Within each section, list entries as a =item entry ]
82
e3c71926 83=head2 New Modules and Pragmata
6d110ad0 84
e3c71926 85=over 4
6d110ad0
FC
86
87=item *
88
0aaeb177 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
f8c9502f
CBW
99L<Archive::Tar> has been upgraded from version 1.80 to version 1.82.
100
101Adjustments to handle files >8gb (>0777777777777 octal) and a feature to
102return the MD5SUM of files in the archive.
a3f52e2e 103
87b9431e
CBW
104=item *
105
74c26f06
CBW
106L<AutoLoader> has been upgraded from version 5.71 to version 5.72.
107
108=item *
109
8cea0f87
CBW
110L<B::Debug> has been upgraded from version 1.16 to version 1.17.
111
112=item *
113
87b9431e
CBW
114L<Compress::Raw::Zlib> has been upgraded from version 2.042 to version 2.043.
115
7e700369
CBW
116=item *
117
118L<Compress::Raw::Bzip2> has been upgraded from version 2.042 to version 2.043.
119
dc7edc5c
CBW
120=item *
121
122L<IO::Compress::Base> has been upgraded from version 2.042 to version 2.043.
123
7788a270
CBW
124=item *
125
b42ff875
CBW
126L<Module::Loaded> has been uprgaded from version 0.06 to version 0.08.
127
128=item *
129
a71d67b1
CBW
130L<Pod::LaTeX> has been upgraded from version 0.59 to version 0.60.
131
132Added another LaTeX escape: --- => -{}-{}-
133
134Pod::LaTeX doesn't handle -- in PODs specially, passing it directly to
135LaTeX, which then proceeds to replace it with a single -. This patch
136replaces ----- with -{}-{}-{}-{}-
137
138=item *
139
65ae8d99 140L<Unicode::Collate> has been upgraded from version 0.85 to version 0.87.
7788a270
CBW
141
142Tailored compatibility ideographs as well as unified ideographs for
143the locales: ja, ko, zh__big5han, zh__gb2312han, zh__pinyin, zh__stroke.
144
65ae8d99
CBW
145Now Locale/*.pl files are searched in @INC.
146
0aaeb177 147=back
6138a722 148
0aaeb177 149=head2 Removed Modules and Pragmata
6138a722 150
0aaeb177 151=over 4
be539103 152
a47fb3fe
CBW
153=item *
154
0aaeb177 155XXX
a3f52e2e 156
0aaeb177 157=back
a3f52e2e 158
0aaeb177 159=head1 Documentation
a3f52e2e 160
0aaeb177
SH
161XXX Changes to files in F<pod/> go here. Consider grouping entries by
162file and be sure to link to the appropriate page, e.g. L<perlfunc>.
a3f52e2e 163
0aaeb177 164=head2 New Documentation
ad32999b 165
0aaeb177 166XXX Changes which create B<new> files in F<pod/> go here.
ad32999b 167
0aaeb177 168=head3 L<XXX>
ad32999b 169
0aaeb177 170XXX Description of the purpose of the new file here
6138a722 171
0aaeb177 172=head2 Changes to Existing Documentation
6138a722 173
0aaeb177
SH
174XXX Changes which significantly change existing files in F<pod/> go here.
175However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
176section.
a47fb3fe 177
0aaeb177 178=head3 L<XXX>
a47fb3fe 179
0aaeb177 180=over 4
7ef25837 181
6d110ad0
FC
182=item *
183
0aaeb177 184XXX Description of the change here
6d110ad0
FC
185
186=back
187
e3c71926
FR
188=head1 Diagnostics
189
190The following additions or changes have been made to diagnostic output,
191including warnings and fatal error messages. For the complete list of
192diagnostic messages, see L<perldiag>.
6d110ad0 193
0aaeb177
SH
194XXX New or changed warnings emitted by the core's C<C> code go here. Also
195include any changes in L<perldiag> that reconcile it to the C<C> code.
6138a722 196
0aaeb177
SH
197[ Within each section, list entries as a =item entry that links to perldiag,
198 e.g.
6138a722 199
0aaeb177 200 =item *
6138a722 201
0aaeb177
SH
202 L<Invalid version object|perldiag/"Invalid version object">
203]
6138a722 204
0aaeb177 205=head2 New Diagnostics
828d6195 206
0aaeb177 207XXX Newly added diagnostic messages go here
83307084 208
0aaeb177 209=head3 New Errors
d39de893 210
3432e5a1 211=over 4
39afdc5a
CBW
212
213=item *
214
0aaeb177 215XXX L<message|perldiag/"message">
6138a722 216
e3c71926 217=back
7b8e5ef0 218
0aaeb177 219=head3 New Warnings
91710846 220
e3c71926 221=over 4
91710846
DG
222
223=item *
224
0aaeb177 225XXX L<message|perldiag/"message">
f81e39ef 226
e3c71926 227=back
a2fa999d 228
0aaeb177
SH
229=head2 Changes to Existing Diagnostics
230
231XXX Changes (i.e. rewording) of diagnostic messages go here
bd65daab 232
e3c71926 233=over 4
bd65daab 234
3f2cb5bf
SM
235=item *
236
0aaeb177 237XXX Describe change here
b420b12a 238
3432e5a1 239=back
b420b12a 240
0aaeb177 241=head1 Utility Changes
9cfd094e 242
0aaeb177
SH
243XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go
244here. Most of these are built within the directories F<utils> and F<x2p>.
95f7e41f 245
0aaeb177
SH
246[ List utility changes as a =head3 entry for each utility and =item
247entries for each change
248Use L<XXX> with program names to get proper documentation linking. ]
95f7e41f 249
0aaeb177 250=head3 L<XXX>
d6cf2367 251
e3c71926 252=over 4
b53e16ae
FC
253
254=item *
255
0aaeb177 256XXX
b53e16ae 257
3432e5a1 258=back
60092ce4 259
0aaeb177
SH
260=head1 Configuration and Compilation
261
262XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
263go here. Any other changes to the Perl build process should be listed here.
264However, any platform-specific changes should be listed in the
265L</Platform Support> section, instead.
266
267[ List changes as a =item entry ].
309aab3a 268
e3c71926 269=over 4
b53e16ae
FC
270
271=item *
272
60f0ee9d
NC
273F<pod/roffitall> is now build by F<pod/buildtoc>, instead of being shipped
274with the distribution. Its list of manpages is now generated (and therefore
275current). See also RT #103202 for an unresolved related issue.
a3f52e2e 276
0aaeb177 277=back
a3f52e2e 278
0aaeb177 279=head1 Testing
a3f52e2e 280
0aaeb177
SH
281XXX Any significant changes to the testing of a freshly built perl should be
282listed here. Changes which create B<new> files in F<t/> go here as do any
283large changes to the testing harness (e.g. when parallel testing was added).
284Changes to existing files in F<t/> aren't worth summarising, although the bugs
285that they represent may be covered elsewhere.
a3f52e2e 286
0aaeb177 287[ List each test improvement as a =item entry ]
a3f52e2e 288
0aaeb177 289=over 4
a3f52e2e
FC
290
291=item *
292
0aaeb177 293XXX
a3f52e2e 294
0aaeb177 295=back
a3f52e2e 296
0aaeb177 297=head1 Platform Support
a3f52e2e 298
0aaeb177 299XXX Any changes to platform support should be listed in the sections below.
a3f52e2e 300
0aaeb177
SH
301[ Within the sections, list each platform as a =item entry with specific
302changes as paragraphs below it. ]
a3f52e2e 303
0aaeb177 304=head2 New Platforms
a3f52e2e 305
0aaeb177
SH
306XXX List any platforms that this version of perl compiles on, that previous
307versions did not. These will either be enabled by new files in the F<hints/>
308directories, or new subdirectories and F<README> files at the top level of the
309source tree.
a3f52e2e 310
0aaeb177 311=over 4
a3f52e2e 312
0aaeb177 313=item XXX-some-platform
a3f52e2e 314
0aaeb177 315XXX
a3f52e2e 316
0aaeb177 317=back
a3f52e2e 318
0aaeb177 319=head2 Discontinued Platforms
ca955add 320
0aaeb177 321XXX List any platforms that this version of perl no longer compiles on.
bbdd8bad 322
0aaeb177 323=over 4
bbdd8bad 324
0aaeb177 325=item XXX-some-platform
ad32999b 326
0aaeb177 327XXX
ad32999b 328
0aaeb177 329=back
ad32999b 330
0aaeb177 331=head2 Platform-Specific Notes
ad32999b 332
0aaeb177
SH
333XXX List any changes for specific platforms. This could include configuration
334and compilation changes or changes in portability/compatibility. However,
335changes within modules for platforms should generally be listed in the
336L</Modules and Pragmata> section.
ad32999b 337
0aaeb177 338=over 4
ad32999b 339
0aaeb177 340=item XXX-some-platform
ad32999b 341
0aaeb177 342XXX
ad32999b 343
0aaeb177 344=back
ad32999b 345
0aaeb177 346=head1 Internal Changes
ad32999b 347
0aaeb177
SH
348XXX Changes which affect the interface available to C<XS> code go here.
349Other significant internal changes for future core maintainers should
350be noted as well.
ad32999b 351
0aaeb177 352[ List each change as a =item entry ]
ad32999b 353
0aaeb177 354=over 4
ad32999b 355
3973654e
FC
356=item *
357
0aaeb177 358XXX
3973654e 359
0aaeb177 360=back
cca38fda 361
0aaeb177 362=head1 Selected Bug Fixes
9c7c1651 363
0aaeb177
SH
364XXX Important bug fixes in the core language are summarised here.
365Bug fixes in files in F<ext/> and F<lib/> are best summarised in
366L</Modules and Pragmata>.
9c7c1651 367
0aaeb177 368[ List each fix as a =item entry ]
fce59cd4 369
0aaeb177 370=over 4
fce59cd4 371
b9e83cd1
FC
372=item *
373
0aaeb177 374XXX
b9e83cd1 375
0aaeb177 376=back
bf19b80e 377
0aaeb177 378=head1 Known Problems
bf19b80e 379
0aaeb177
SH
380XXX Descriptions of platform agnostic bugs we know we can't fix go here. Any
381tests that had to be C<TODO>ed for the release would be noted here, unless
382they were specific to a particular platform (see below).
65b66aa9 383
0aaeb177
SH
384This is a list of some significant unfixed bugs, which are regressions
385from either 5.XXX.XXX or 5.XXX.XXX.
65b66aa9 386
0aaeb177 387[ List each fix as a =item entry ]
b53e16ae 388
0aaeb177 389=over 4
b53e16ae 390
7c864bb3
VP
391=item *
392
0aaeb177 393XXX
7c864bb3 394
63ac71b9 395=back
bbc28bfc 396
0aaeb177 397=head1 Obituary
8fe05716 398
0aaeb177
SH
399XXX If any significant core contributor has died, we've added a short obituary
400here.
8fe05716 401
0aaeb177 402=head1 Acknowledgements
8fe05716 403
0aaeb177 404XXX Generate this with:
8fe05716 405
0aaeb177 406 perl Porting/acknowledgements.pl v5.15.5..HEAD
29cf780c 407
44691e6f
AB
408=head1 Reporting Bugs
409
410If you find what you think is a bug, you might check the articles
34dc2ec0 411recently posted to the comp.lang.perl.misc newsgroup and the perl
44691e6f
AB
412bug database at http://rt.perl.org/perlbug/ . There may also be
413information at http://www.perl.org/ , the Perl Home Page.
414
415If you believe you have an unreported bug, please run the L<perlbug>
416program included with your release. Be sure to trim your bug down
417to a tiny but sufficient test case. Your bug report, along with the
418output of C<perl -V>, will be sent off to perlbug@perl.org to be
419analysed by the Perl porting team.
420
421If the bug you are reporting has security implications, which make it
422inappropriate to send to a publicly archived mailing list, then please send
34dc2ec0 423it to perl5-security-report@perl.org. This points to a closed subscription
b4707b2a
FC
424unarchived mailing list, which includes
425all the core committers, who will be able
44691e6f
AB
426to help assess the impact of issues, figure out a resolution, and help
427co-ordinate the release of patches to mitigate or fix the problem across all
34dc2ec0
DM
428platforms on which Perl is supported. Please only use this address for
429security issues in the Perl core, not for modules independently
44691e6f
AB
430distributed on CPAN.
431
432=head1 SEE ALSO
433
434The F<Changes> file for an explanation of how to view exhaustive details
435on what changed.
436
437The F<INSTALL> file for how to build Perl.
438
439The F<README> file for general stuff.
440
441The F<Artistic> and F<Copying> files for copyright information.
442
443=cut