This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
git-deltatool: added a progress counter
[perl5.git] / pod / perldelta.pod
CommitLineData
44691e6f
AB
1=encoding utf8
2
3=head1 NAME
4
34dc2ec0
DM
5[ this is a template for a new perldelta file. Any text flagged as
6XXX needs to be processed before release. ]
c71a852f 7
34dc2ec0 8perldelta - what is new for perl v5.15.0
6e925ecb 9
34dc2ec0 10=head1 DESCRIPTION
a27ff1be 11
34dc2ec0
DM
12This document describes differences between the 5.15.0 release and
13the 5.14.0 release.
a27ff1be 14
34dc2ec0
DM
15If you are upgrading from an earlier release such as 5.YYY.YYY, first read
16L<perl5YYYdelta>, which describes differences between 5.ZZZ.ZZZ and
175.YYY.YYY.
a27ff1be 18
34dc2ec0 19=head1 Notice
a27ff1be 20
34dc2ec0 21XXX Any important notices here
a27ff1be 22
34dc2ec0 23=head1 Core Enhancements
a27ff1be 24
34dc2ec0
DM
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.
a27ff1be 28
34dc2ec0 29[ List each enhancement as a =head2 entry ]
a27ff1be 30
34dc2ec0 31=head1 Security
a27ff1be 32
34dc2ec0
DM
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.
a27ff1be 36
34dc2ec0 37[ List each security issue as a =head2 entry ]
a27ff1be 38
34dc2ec0 39=head1 Incompatible Changes
9a5a48b7 40
34dc2ec0 41[ List each incompatible change as a =head2 entry ]
9a5a48b7 42
34dc2ec0 43=head1 Deprecations
cdc10f43 44
34dc2ec0
DM
45XXX Any deprecated features, syntax, modules etc. should be listed here.
46In particular, deprecated modules should be listed here even if they are
47listed as an updated module in the L</Modules and Pragmata> section.
cdc10f43 48
34dc2ec0 49[ List each deprecation as a =head2 entry ]
9a5a48b7 50
34dc2ec0 51=head1 Performance Enhancements
9a5a48b7 52
34dc2ec0
DM
53XXX Changes which enhance performance without changing behaviour go here. There
54may well be none in a stable release.
9a5a48b7 55
34dc2ec0 56[ List each enhancement as a =item entry ]
9a5a48b7 57
34dc2ec0 58=over 4
c8c13991 59
5076a392
FC
60=item *
61
34dc2ec0 62XXX
e8e35311
FC
63
64=back
65
34dc2ec0 66=head1 Modules and Pragmata
c8c13991 67
34dc2ec0
DM
68XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
69go here. If Module::CoreList is updated, generate an initial draft of the
70following sections using F<Porting/corelist-perldelta.pl>, which prints stub
71entries to STDOUT. Results can be pasted in place of the '=head2' entries
72below. A paragraph summary for important changes should then be added by hand.
73In an ideal world, dual-life modules would have a F<Changes> file that could be
74cribbed.
f00d3350 75
34dc2ec0 76[ Within each section, list entries as a =item entry ]
e9784f55 77
34dc2ec0 78=head2 New Modules and Pragmata
d430b8e7 79
34dc2ec0 80=over 4
d430b8e7 81
31ecc2aa
FC
82=item *
83
34dc2ec0 84XXX
31ecc2aa 85
e9784f55 86=back
c34a735e 87
34dc2ec0 88=head2 Updated Modules and Pragmata
24b164a5 89
34dc2ec0 90=over 4
2c389f6c 91
9780b8fa
FC
92=item *
93
daca484d
NC
94L<B> has been upgraded from version 1.29 to version 1.30.
95
96=item *
97
f95396b3 98L<Math::Complex> has been upgraded from version 1.56 to version 1.57.
3194a40a
Z
99
100Correct copy constructor usage.
101Fix polarwise formatting with numeric format specifier.
102More stable C<great_circle_direction> algorithm.
103
104=item *
105
e5904012
NC
106L<PerlIO::encoding> has been upgraded from version 0.14 to 0.15
107
108=item *
109
daca484d
NC
110L<Storable> has been upgraded from version 2.27 to version 2.28.
111
112=item *
113
f95396b3 114L<Time::HiRes> has been upgraded from version 1.9721_01 to version 1.9722.
91a2e9f6
Z
115
116Portability fix, and avoiding some compiler warnings.
117
118=item *
119
34dc2ec0 120XXX
9780b8fa 121
e8e35311
FC
122=back
123
34dc2ec0 124=head2 Removed Modules and Pragmata
bdb0cce8 125
34dc2ec0 126=over 4
44691e6f 127
5076a392 128=item *
44691e6f 129
34dc2ec0 130XXX
e8e35311
FC
131
132=back
133
34dc2ec0 134=head1 Documentation
44691e6f 135
34dc2ec0
DM
136XXX Changes to files in F<pod/> go here. Consider grouping entries by
137file and be sure to link to the appropriate page, e.g. L<perlfunc>.
6d96b0fe 138
34dc2ec0 139=head2 New Documentation
6d96b0fe 140
34dc2ec0 141XXX Changes which create B<new> files in F<pod/> go here.
6d96b0fe 142
34dc2ec0 143=head3 L<XXX>
e8e35311 144
34dc2ec0 145XXX Description of the purpose of the new file here
6d96b0fe 146
34dc2ec0 147=head2 Changes to Existing Documentation
b7188eb5 148
34dc2ec0
DM
149XXX Changes which significantly change existing files in F<pod/> go here.
150However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
151section.
b7188eb5 152
34dc2ec0 153=head3 L<XXX>
b7188eb5 154
34dc2ec0 155=over 4
e8e35311 156
2c389f6c
FC
157=item *
158
34dc2ec0 159XXX Description of the change here
2c389f6c 160
e8e35311
FC
161=back
162
34dc2ec0 163=head1 Diagnostics
b7188eb5 164
34dc2ec0
DM
165The following additions or changes have been made to diagnostic output,
166including warnings and fatal error messages. For the complete list of
167diagnostic messages, see L<perldiag>.
44691e6f 168
34dc2ec0
DM
169XXX New or changed warnings emitted by the core's C<C> code go here. Also
170include any changes in L<perldiag> that reconcile it to the C<C> code.
6c9cd4a1 171
34dc2ec0 172[ Within each section, list entries as a =item entry ]
6c9cd4a1 173
34dc2ec0 174=head2 New Diagnostics
44691e6f 175
34dc2ec0 176XXX Newly added diagnostic messages go here
44691e6f 177
34dc2ec0 178=over 4
44691e6f 179
5076a392 180=item *
44691e6f 181
34dc2ec0 182XXX
2c389f6c
FC
183
184=back
185
34dc2ec0 186=head2 Changes to Existing Diagnostics
b7188eb5 187
34dc2ec0 188XXX Changes (i.e. rewording) of diagnostic messages go here
b7188eb5 189
34dc2ec0 190=over 4
b7188eb5 191
5076a392 192=item *
b7188eb5 193
34dc2ec0 194XXX
b7188eb5 195
e8e35311 196=back
5076a392 197
34dc2ec0 198=head1 Utility Changes
5076a392 199
34dc2ec0
DM
200XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go
201here. Most of these are built within the directories F<utils> and F<x2p>.
5076a392 202
34dc2ec0
DM
203[ List utility changes as a =head3 entry for each utility and =item
204entries for each change
205Use L<XXX> with program names to get proper documentation linking. ]
5076a392 206
34dc2ec0 207=head3 L<XXX>
5076a392 208
34dc2ec0 209=over 4
5076a392
FC
210
211=item *
212
34dc2ec0 213XXX
5076a392 214
2c389f6c 215=back
e8e35311 216
34dc2ec0 217=head1 Configuration and Compilation
5076a392 218
34dc2ec0
DM
219XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
220go here. Any other changes to the Perl build process should be listed here.
221However, any platform-specific changes should be listed in the
222L</Platform Support> section, instead.
2c389f6c 223
34dc2ec0 224[ List changes as a =item entry ].
2c389f6c 225
34dc2ec0 226=over 4
5076a392 227
e8e35311 228=item *
5076a392 229
34dc2ec0 230XXX
5076a392 231
34dc2ec0 232=back
5076a392 233
34dc2ec0 234=head1 Testing
5076a392 235
34dc2ec0
DM
236XXX Any significant changes to the testing of a freshly built perl should be
237listed here. Changes which create B<new> files in F<t/> go here as do any
238large changes to the testing harness (e.g. when parallel testing was added).
239Changes to existing files in F<t/> aren't worth summarising, although the bugs
240that they represent may be covered elsewhere.
5076a392 241
34dc2ec0 242[ List each test improvement as a =item entry ]
5076a392 243
34dc2ec0 244=over 4
5076a392
FC
245
246=item *
247
34dc2ec0 248XXX
e8e35311 249
34dc2ec0 250=back
5076a392 251
34dc2ec0 252=head1 Platform Support
5076a392 253
34dc2ec0 254XXX Any changes to platform support should be listed in the sections below.
5076a392 255
34dc2ec0
DM
256[ Within the sections, list each platform as a =item entry with specific
257changes as paragraphs below it. ]
5076a392 258
34dc2ec0 259=head2 New Platforms
5076a392 260
34dc2ec0
DM
261XXX List any platforms that this version of perl compiles on, that previous
262versions did not. These will either be enabled by new files in the F<hints/>
263directories, or new subdirectories and F<README> files at the top level of the
264source tree.
cdc10f43 265
34dc2ec0 266=over 4
cdc10f43 267
34dc2ec0 268=item XXX-some-platform
d430b8e7 269
34dc2ec0 270XXX
d430b8e7 271
2c389f6c 272=back
5076a392 273
34dc2ec0 274=head2 Discontinued Platforms
5076a392 275
34dc2ec0 276XXX List any platforms that this version of perl no longer compiles on.
5076a392 277
34dc2ec0 278=over 4
e8e35311 279
34dc2ec0 280=item XXX-some-platform
e8e35311 281
34dc2ec0 282XXX
1e463951 283
c71a852f 284=back
b7188eb5 285
34dc2ec0 286=head2 Platform-Specific Notes
42a91c97 287
34dc2ec0
DM
288XXX List any changes for specific platforms. This could include configuration
289and compilation changes or changes in portability/compatibility. However,
290changes within modules for platforms should generally be listed in the
291L</Modules and Pragmata> section.
42a91c97 292
34dc2ec0 293=over 4
42a91c97 294
34dc2ec0 295=item XXX-some-platform
42a91c97 296
34dc2ec0 297XXX
42a91c97 298
34dc2ec0 299=back
42a91c97 300
34dc2ec0 301=head1 Internal Changes
42a91c97 302
34dc2ec0
DM
303XXX Changes which affect the interface available to C<XS> code go here.
304Other significant internal changes for future core maintainers should
305be noted as well.
42a91c97 306
34dc2ec0 307=over 4
42a91c97 308
2c389f6c
FC
309=item *
310
74e0ddf7
NC
311The compiled representation of formats is now stored via the mg_ptr of
312their PERL_MAGIC_fm. Previously it was stored in the string buffer,
313beyond SvLEN(), the regular end of the string. SvCOMPILED() and
314SvCOMPILED_{on,off}() now exist solely for compatibility for XS code.
315The first is always 0, the other two now no-ops.
cdc10f43 316
34dc2ec0 317=back
cdc10f43 318
34dc2ec0 319=head1 Selected Bug Fixes
cdc10f43 320
34dc2ec0
DM
321XXX Important bug fixes in the core language are summarised here.
322Bug fixes in files in F<ext/> and F<lib/> are best summarised in
323L</Modules and Pragmata>.
cdc10f43 324
34dc2ec0 325[ List each fix as a =item entry ]
d430b8e7 326
34dc2ec0 327=over 4
d430b8e7
FC
328
329=item *
330
34dc2ec0 331XXX
d430b8e7 332
42a91c97
FC
333=back
334
c71a852f 335=head1 Known Problems
44691e6f 336
34dc2ec0
DM
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, unless
339they were specific to a particular platform (see below).
cdc10f43 340
34dc2ec0
DM
341This is a list of some significant unfixed bugs, which are regressions
342from either 5.XXX.XXX or 5.XXX.XXX.
cdc10f43 343
34dc2ec0 344[ List each fix as a =item entry ]
ca767864 345
34dc2ec0 346=over 4
cf5da40b
CB
347
348=item *
349
34dc2ec0 350XXX
cf5da40b 351
c71a852f 352=back
014fb485 353
c71a852f 354=head1 Obituary
014fb485 355
34dc2ec0
DM
356XXX If any significant core contributor has died, we've added a short obituary
357here.
44691e6f 358
44691e6f
AB
359=head1 Acknowledgements
360
34dc2ec0 361XXX The list of people to thank goes here.
29cf780c 362
44691e6f
AB
363=head1 Reporting Bugs
364
365If you find what you think is a bug, you might check the articles
34dc2ec0 366recently posted to the comp.lang.perl.misc newsgroup and the perl
44691e6f
AB
367bug database at http://rt.perl.org/perlbug/ . There may also be
368information at http://www.perl.org/ , the Perl Home Page.
369
370If you believe you have an unreported bug, please run the L<perlbug>
371program included with your release. Be sure to trim your bug down
372to a tiny but sufficient test case. Your bug report, along with the
373output of C<perl -V>, will be sent off to perlbug@perl.org to be
374analysed by the Perl porting team.
375
376If the bug you are reporting has security implications, which make it
377inappropriate to send to a publicly archived mailing list, then please send
34dc2ec0 378it to perl5-security-report@perl.org. This points to a closed subscription
44691e6f
AB
379unarchived mailing list, which includes all the core committers, who be able
380to help assess the impact of issues, figure out a resolution, and help
381co-ordinate the release of patches to mitigate or fix the problem across all
34dc2ec0
DM
382platforms on which Perl is supported. Please only use this address for
383security issues in the Perl core, not for modules independently
44691e6f
AB
384distributed on CPAN.
385
386=head1 SEE ALSO
387
388The F<Changes> file for an explanation of how to view exhaustive details
389on what changed.
390
391The F<INSTALL> file for how to build Perl.
392
393The F<README> file for general stuff.
394
395The F<Artistic> and F<Copying> files for copyright information.
396
397=cut