This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Update Digest to CPAN version 1.17
[perl5.git] / pod / perldelta.pod
CommitLineData
44691e6f
AB
1=encoding utf8
2
3=head1 NAME
4
3432e5a1
SL
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.4
760696b8 9
5438d4b8 10=head1 DESCRIPTION
5cd408a2 11
3432e5a1
SL
12This document describes differences between the 5.15.3 release and
13the 5.15.4 release.
5cd408a2 14
3432e5a1
SL
15If you are upgrading from an earlier release such as 5.15.3, first read
16L<perl5153delta>, which describes differences between 5.15.3 and
175.15.4.
062678b2 18
63ac71b9 19=head1 Notice
4185c919 20
3432e5a1 21XXX Any important notices here
0afed34d 22
63ac71b9 23=head1 Core Enhancements
0afed34d 24
3f728e2e 25=head2 $^X converted to an absolute path on FreeBSD, OS X and Solaris
d2006265 26
3f728e2e
NC
27C<$^X> is now converted to an absolute path on OS X, FreeBSD (without
28needing F</proc> mounted) and Solaris 10 and 11. This augments the
29previous approach of using F</proc> on Linux, FreeBSD and NetBSD
30(in all cases, where mounted).
31
32This makes relocatable perl installations more useful on these platforms.
33(See "Relocatable @INC" in F<INSTALL>)
d6cf2367 34
63ac71b9 35=head1 Security
0afed34d 36
3432e5a1
SL
37XXX Any security-related notices go here. In particular, any security
38vulnerabilities closed should be noted here rather than in the
39L</Selected Bug Fixes> section.
46661105 40
3432e5a1 41[ List each security issue as a =head2 entry ]
46661105 42
5438d4b8 43=head1 Incompatible Changes
7818c927 44
3432e5a1 45XXX For a release on a stable branch, this section aspires to be:
e1dccc0d 46
3432e5a1
SL
47 There are no changes intentionally incompatible with 5.XXX.XXX
48 If any exist, they are bugs and reports are welcome.
7b2b001e 49
3432e5a1 50[ List each incompatible change as a =head2 entry ]
bdb9ba77 51
3432e5a1 52=head1 Deprecations
7ec04da5 53
3432e5a1
SL
54XXX Any deprecated features, syntax, modules etc. should be listed here.
55In particular, deprecated modules should be listed here even if they are
56listed as an updated module in the L</Modules and Pragmata> section.
7ec04da5 57
3432e5a1 58[ List each deprecation as a =head2 entry ]
d6cf2367 59
3432e5a1 60=head1 Performance Enhancements
d6cf2367 61
3432e5a1
SL
62XXX Changes which enhance performance without changing behaviour go here. There
63may well be none in a stable release.
5d4ff231 64
3432e5a1 65[ List each enhancement as a =item entry ]
e46d9735 66
63ac71b9 67=over 4
e46d9735
CBW
68
69=item *
70
3432e5a1 71XXX
828d6195 72
3432e5a1 73=back
83307084 74
3432e5a1 75=head1 Modules and Pragmata
83307084 76
3432e5a1
SL
77XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
78go here. If Module::CoreList is updated, generate an initial draft of the
79following sections using F<Porting/corelist-perldelta.pl>, which prints stub
80entries to STDOUT. Results can be pasted in place of the '=head2' entries
81below. A paragraph summary for important changes should then be added by hand.
82In an ideal world, dual-life modules would have a F<Changes> file that could be
83cribbed.
83307084 84
3432e5a1 85[ Within each section, list entries as a =item entry ]
83307084 86
3432e5a1 87=head2 New Modules and Pragmata
d93f0209 88
3432e5a1 89=over 4
d93f0209 90
60527824
FR
91=item *
92
3432e5a1 93XXX
d6cf2367 94
3432e5a1 95=back
d39de893 96
3432e5a1 97=head2 Updated Modules and Pragmata
d39de893 98
3432e5a1 99=over 4
39afdc5a
CBW
100
101=item *
102
2480ae1c 103L<perlfaq> has been upgraded from version 5.0150034 to version 5.0150035.
666c7ca6 104
7b8e5ef0
GG
105=item *
106
a2fa999d
CBW
107L<Digest> has been upgraded from version 1.16 to version 1.17.
108
109=item *
110
7b8e5ef0
GG
111L<ExtUtils::MakeMaker> has been upgraded from version 6.59 to version 6.61_01.
112
3432e5a1 113=back
666c7ca6 114
3432e5a1 115=head2 Removed Modules and Pragmata
d6cf2367 116
3432e5a1 117=over 4
d6cf2367
FC
118
119=item *
120
3432e5a1 121XXX
a9feb6cb 122
3432e5a1 123=back
a9feb6cb 124
3432e5a1 125=head1 Documentation
8fe353ef 126
3432e5a1
SL
127XXX Changes to files in F<pod/> go here. Consider grouping entries by
128file and be sure to link to the appropriate page, e.g. L<perlfunc>.
8fe353ef 129
3432e5a1 130=head2 New Documentation
8fe353ef 131
3432e5a1 132XXX Changes which create B<new> files in F<pod/> go here.
60527824 133
3432e5a1 134=head3 L<XXX>
7ac26854 135
3432e5a1 136XXX Description of the purpose of the new file here
7ac26854 137
3432e5a1 138=head2 Changes to Existing Documentation
7ac26854 139
3432e5a1
SL
140XXX Changes which significantly change existing files in F<pod/> go here.
141However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
142section.
518487b2 143
3432e5a1 144=head3 L<XXX>
daef35db 145
3432e5a1 146=over 4
83307084
SL
147
148=item *
149
3432e5a1 150XXX Description of the change here
b420b12a 151
3432e5a1 152=back
b420b12a 153
3432e5a1 154=head1 Diagnostics
83307084 155
3432e5a1
SL
156The following additions or changes have been made to diagnostic output,
157including warnings and fatal error messages. For the complete list of
158diagnostic messages, see L<perldiag>.
83307084 159
3432e5a1
SL
160XXX New or changed warnings emitted by the core's C<C> code go here. Also
161include any changes in L<perldiag> that reconcile it to the C<C> code.
83307084 162
3432e5a1
SL
163[ Within each section, list entries as a =item entry that links to perldiag,
164 e.g.
83307084 165
3432e5a1 166 =item *
d6cf2367 167
3432e5a1
SL
168 L<Invalid version object|perldiag/"Invalid version object">
169]
d6cf2367 170
3432e5a1 171=head2 New Diagnostics
d6cf2367 172
3432e5a1 173XXX Newly added diagnostic messages go here
daef35db 174
3432e5a1 175=head3 New Errors
259925f6 176
3432e5a1 177=over 4
9840cdee
CBW
178
179=item *
180
3432e5a1 181XXX L<message|perldiag/"message">
54e02335 182
63ac71b9 183=back
310913d4 184
3432e5a1 185=head3 New Warnings
dc80b0c6 186
63ac71b9 187=over 4
83b32788
CBW
188
189=item *
190
3432e5a1 191XXX L<message|perldiag/"message">
4eb81ef2 192
63ac71b9 193=back
4eb81ef2 194
3432e5a1
SL
195=head2 Changes to Existing Diagnostics
196
197XXX Changes (i.e. rewording) of diagnostic messages go here
d6cf2367
FC
198
199=over 4
200
201=item *
202
c634fdd3
KW
203The message,
204"Code point 0x%X is not Unicode, no properties match it; all inverse
205prop erties do" has been changed to "Code point 0x%X is not Unicode, all
206\p{} matches fail; all \P{} matches succeed"
207
d6cf2367
FC
208
209=back
210
3432e5a1 211=head1 Utility Changes
d6cf2367 212
3432e5a1
SL
213XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go
214here. Most of these are built within the directories F<utils> and F<x2p>.
b89e9b0d 215
3432e5a1
SL
216[ List utility changes as a =head3 entry for each utility and =item
217entries for each change
218Use L<XXX> with program names to get proper documentation linking. ]
0cb4637e 219
3432e5a1 220=head3 L<XXX>
4abaf918 221
5438d4b8 222=over 4
4abaf918
Z
223
224=item *
225
3432e5a1 226XXX
8b00e523 227
e8e35311
FC
228=back
229
63ac71b9 230=head1 Configuration and Compilation
b908e258 231
3432e5a1
SL
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.
b908e258 236
3432e5a1 237[ List changes as a =item entry ].
bbc28bfc 238
34dc2ec0 239=over 4
42a91c97 240
6693394d 241=item *
42a91c97 242
3432e5a1 243XXX
d2006265 244
3432e5a1 245=back
9cfd094e 246
3432e5a1 247=head1 Testing
9cfd094e 248
3432e5a1
SL
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 summarising, although the bugs
253that they represent may be covered elsewhere.
9cfd094e 254
3432e5a1 255[ List each test improvement as a =item entry ]
7c4c6e7c 256
3432e5a1 257=over 4
95f7e41f 258
83307084 259=item *
95f7e41f 260
6692294e
NC
261F<t/porting/checkcfgvar.t> now tests that all config.sh-style files are
262complete. These are used by the various non-*nix to generate their
263F<config.h>, and an incomplete input file will generate invalid output.
df5b44bd 264
63ac71b9 265=back
310913d4 266
83307084 267=head1 Platform Support
df5b44bd 268
3432e5a1 269XXX Any changes to platform support should be listed in the sections below.
7818c927 270
3432e5a1
SL
271[ Within the sections, list each platform as a =item entry with specific
272changes as paragraphs below it. ]
83307084 273
3432e5a1 274=head2 New Platforms
7818c927 275
3432e5a1
SL
276XXX List any platforms that this version of perl compiles on, that previous
277versions did not. These will either be enabled by new files in the F<hints/>
278directories, or new subdirectories and F<README> files at the top level of the
279source tree.
3fdd840f 280
63ac71b9 281=over 4
7ffa7e75 282
3432e5a1 283=item XXX-some-platform
862b2c43 284
3432e5a1 285XXX
d6cf2367 286
63ac71b9 287=back
c973bd4f 288
3432e5a1 289=head2 Discontinued Platforms
fdd313f4 290
3432e5a1 291XXX List any platforms that this version of perl no longer compiles on.
c39e29ea 292
3432e5a1 293=over 4
c39e29ea 294
3432e5a1 295=item XXX-some-platform
c39e29ea 296
3432e5a1 297XXX
d6cf2367 298
3432e5a1 299=back
d6cf2367 300
3432e5a1 301=head2 Platform-Specific Notes
d6cf2367 302
3432e5a1
SL
303XXX List any changes for specific platforms. This could include configuration
304and compilation changes or changes in portability/compatibility. However,
305changes within modules for platforms should generally be listed in the
306L</Modules and Pragmata> section.
d6cf2367 307
3432e5a1 308=over 4
d6cf2367 309
3432e5a1 310=item XXX-some-platform
d6cf2367 311
3432e5a1 312XXX
d6cf2367 313
3432e5a1 314=back
d6cf2367 315
3432e5a1 316=head1 Internal Changes
d6cf2367 317
3432e5a1
SL
318XXX Changes which affect the interface available to C<XS> code go here.
319Other significant internal changes for future core maintainers should
320be noted as well.
d6cf2367 321
3432e5a1 322[ List each change as a =item entry ]
5d4ff231 323
3432e5a1 324=over 4
5d4ff231 325
a3342be3
FC
326=item *
327
3432e5a1 328XXX
60092ce4 329
3432e5a1 330=back
60092ce4 331
3432e5a1 332=head1 Selected Bug Fixes
309aab3a 333
3432e5a1
SL
334XXX Important bug fixes in the core language are summarised here.
335Bug fixes in files in F<ext/> and F<lib/> are best summarised in
336L</Modules and Pragmata>.
309aab3a 337
3432e5a1 338[ List each fix as a =item entry ]
1f26655e 339
3432e5a1 340=over 4
1f26655e 341
433644ee
FC
342=item *
343
3432e5a1 344XXX
433644ee 345
63ac71b9 346=back
bbc28bfc 347
7d3f03b7
SL
348=head1 Known Problems
349
3432e5a1
SL
350XXX Descriptions of platform agnostic bugs we know we can't fix go here. Any
351tests that had to be C<TODO>ed for the release would be noted here, unless
352they were specific to a particular platform (see below).
7d3f03b7 353
3432e5a1
SL
354This is a list of some significant unfixed bugs, which are regressions
355from either 5.XXX.XXX or 5.XXX.XXX.
356
357[ List each fix as a =item entry ]
7d3f03b7 358
3432e5a1 359=over 4
7d3f03b7
SL
360
361=item *
362
3432e5a1 363XXX
7d3f03b7 364
3432e5a1 365=back
7d3f03b7 366
3432e5a1 367=head1 Obituary
7d3f03b7 368
3432e5a1
SL
369XXX If any significant core contributor has died, we've added a short obituary
370here.
7d3f03b7 371
44691e6f
AB
372=head1 Acknowledgements
373
3432e5a1
SL
374XXX Generate this with:
375
376 perl Porting/acknowledgements.pl v5.15.3..HEAD
29cf780c 377
44691e6f
AB
378=head1 Reporting Bugs
379
380If you find what you think is a bug, you might check the articles
34dc2ec0 381recently posted to the comp.lang.perl.misc newsgroup and the perl
44691e6f
AB
382bug database at http://rt.perl.org/perlbug/ . There may also be
383information at http://www.perl.org/ , the Perl Home Page.
384
385If you believe you have an unreported bug, please run the L<perlbug>
386program included with your release. Be sure to trim your bug down
387to a tiny but sufficient test case. Your bug report, along with the
388output of C<perl -V>, will be sent off to perlbug@perl.org to be
389analysed by the Perl porting team.
390
391If the bug you are reporting has security implications, which make it
392inappropriate to send to a publicly archived mailing list, then please send
34dc2ec0 393it to perl5-security-report@perl.org. This points to a closed subscription
b4707b2a
FC
394unarchived mailing list, which includes
395all the core committers, who will be able
44691e6f
AB
396to help assess the impact of issues, figure out a resolution, and help
397co-ordinate the release of patches to mitigate or fix the problem across all
34dc2ec0
DM
398platforms on which Perl is supported. Please only use this address for
399security issues in the Perl core, not for modules independently
44691e6f
AB
400distributed on CPAN.
401
402=head1 SEE ALSO
403
404The F<Changes> file for an explanation of how to view exhaustive details
405on what changed.
406
407The F<INSTALL> file for how to build Perl.
408
409The F<README> file for general stuff.
410
411The F<Artistic> and F<Copying> files for copyright information.
412
413=cut