This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Remove .ph tests from perlivp
[perl5.git] / pod / perldelta.pod
CommitLineData
44691e6f
AB
1=encoding utf8
2
3=head1 NAME
4
5438d4b8
Z
5[ this is a template for a new perldelta file. Any text flagged as
6XXX needs to be processed before release. ]
f5938650 7
5438d4b8 8perldelta - what is new for perl v5.15.2
760696b8 9
5438d4b8 10=head1 DESCRIPTION
5cd408a2 11
5438d4b8
Z
12This document describes differences between the 5.15.1 release and
13the 5.15.2 release.
5cd408a2 14
5438d4b8
Z
15If you are upgrading from an earlier release such as 5.15.0, first read
16L<perl5151delta>, which describes differences between 5.15.0 and
175.15.1.
062678b2 18
5438d4b8 19=head1 Notice
062678b2 20
5438d4b8 21XXX Any important notices here
4185c919 22
5438d4b8 23=head1 Core Enhancements
4185c919 24
5438d4b8
Z
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.
82aed44a 28
5438d4b8 29[ List each enhancement as a =head2 entry ]
82aed44a 30
5438d4b8 31=head1 Security
2b679393 32
5438d4b8
Z
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.
2b679393 36
5438d4b8 37[ List each security issue as a =head2 entry ]
7818c927 38
5438d4b8 39=head1 Incompatible Changes
7818c927 40
5438d4b8 41XXX For a release on a stable branch, this section aspires to be:
760696b8 42
5438d4b8
Z
43 There are no changes intentionally incompatible with 5.XXX.XXX
44 If any exist, they are bugs and reports are welcome.
6693394d 45
5438d4b8 46[ List each incompatible change as a =head2 entry ]
6693394d 47
5438d4b8 48=head1 Deprecations
92c695db 49
5438d4b8
Z
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.
92c695db 53
5438d4b8 54[ List each deprecation as a =head2 entry ]
6693394d 55
5438d4b8 56=head1 Performance Enhancements
bfafcb9a 57
5438d4b8
Z
58XXX Changes which enhance performance without changing behaviour go here. There
59may well be none in a stable release.
bfafcb9a 60
5438d4b8 61[ List each enhancement as a =item entry ]
72de20cd 62
5438d4b8 63=over 4
72de20cd 64
93905212
FC
65=item *
66
5438d4b8 67XXX
93905212 68
6693394d
FC
69=back
70
0890f1a5 71=head1 Modules and Pragmata
bdb9ba77 72
5438d4b8
Z
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
0890f1a5 83=head2 New Modules and Pragmata
6693394d 84
0890f1a5 85=over 4
6693394d
FC
86
87=item *
88
5438d4b8 89XXX
6693394d
FC
90
91=back
92
0890f1a5 93=head2 Updated Modules and Pragmata
760696b8 94
0890f1a5 95=over 4
760696b8
FC
96
97=item *
98
5438d4b8 99L<XXX> has been upgraded from version 0.69 to version 0.70.
259925f6 100
5438d4b8 101=back
77ccfaeb 102
5438d4b8 103=head2 Removed Modules and Pragmata
508236ce 104
5438d4b8 105=over 4
508236ce
CBW
106
107=item *
108
5438d4b8 109XXX
c69a30ec 110
5438d4b8 111=back
c69a30ec 112
5438d4b8 113=head1 Documentation
c69a30ec 114
5438d4b8
Z
115XXX Changes to files in F<pod/> go here. Consider grouping entries by
116file and be sure to link to the appropriate page, e.g. L<perlfunc>.
7c420290 117
5438d4b8 118=head2 New Documentation
7c420290 119
5438d4b8 120XXX Changes which create B<new> files in F<pod/> go here.
0cb4637e 121
5438d4b8 122=head3 L<XXX>
7818c927 123
5438d4b8 124XXX Description of the purpose of the new file here
7818c927 125
5438d4b8 126=head2 Changes to Existing Documentation
dd413713 127
5438d4b8
Z
128XXX Changes which significantly change existing files in F<pod/> go here.
129However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
130section.
7818c927 131
5438d4b8 132=head3 L<XXX>
7818c927 133
5438d4b8 134=over 4
7818c927
FC
135
136=item *
137
5438d4b8 138XXX Description of the change here
5aeca1f7 139
5438d4b8 140=back
5aeca1f7 141
5438d4b8 142=head1 Diagnostics
0cb4637e 143
5438d4b8
Z
144The following additions or changes have been made to diagnostic output,
145including warnings and fatal error messages. For the complete list of
146diagnostic messages, see L<perldiag>.
0cb4637e 147
5438d4b8
Z
148XXX New or changed warnings emitted by the core's C<C> code go here. Also
149include any changes in L<perldiag> that reconcile it to the C<C> code.
00f02a57 150
5438d4b8
Z
151[ Within each section, list entries as a =item entry that links to perldiag,
152 e.g.
00f02a57 153
5438d4b8 154 =item *
00f02a57 155
5438d4b8
Z
156 L<Invalid version object|perldiag/"Invalid version object">
157]
8b00e523 158
5438d4b8 159=head2 New Diagnostics
4abaf918 160
5438d4b8 161XXX Newly added diagnostic messages go here
4abaf918 162
5438d4b8 163=head3 New Errors
4abaf918 164
5438d4b8 165=over 4
4abaf918
Z
166
167=item *
168
5438d4b8 169XXX L<message|perldiag/"message">
8b00e523 170
e8e35311
FC
171=back
172
5438d4b8 173=head3 New Warnings
bdb9ba77 174
0890f1a5 175=over 4
bdb9ba77
DG
176
177=item *
178
5438d4b8 179XXX L<message|perldiag/"message">
bdb9ba77
DG
180
181=back
182
5438d4b8 183=head2 Changes to Existing Diagnostics
7818c927 184
5438d4b8 185XXX Changes (i.e. rewording) of diagnostic messages go here
0890f1a5 186
0890f1a5 187=over 4
6693394d
FC
188
189=item *
190
5438d4b8 191XXX Describe change here
259925f6 192
5438d4b8 193=back
7818c927 194
5438d4b8 195=head1 Utility Changes
7818c927 196
5438d4b8
Z
197XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go
198here. Most of these are built within the directories F<utils> and F<x2p>.
7818c927 199
5438d4b8
Z
200[ List utility changes as a =head3 entry for each utility and =item
201entries for each change
202Use L<XXX> with program names to get proper documentation linking. ]
7818c927 203
5438d4b8 204=head3 L<XXX>
b908e258 205
5438d4b8 206=over 4
b908e258
Z
207
208=item *
209
5438d4b8 210XXX
b908e258 211
6693394d
FC
212=back
213
5438d4b8 214=head1 Configuration and Compilation
b7188eb5 215
5438d4b8
Z
216XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
217go here. Any other changes to the Perl build process should be listed here.
218However, any platform-specific changes should be listed in the
219L</Platform Support> section, instead.
44691e6f 220
5438d4b8 221[ List changes as a =item entry ].
42a91c97 222
34dc2ec0 223=over 4
42a91c97 224
6693394d 225=item *
42a91c97 226
5438d4b8 227XXX
42a91c97 228
34dc2ec0 229=back
42a91c97 230
0890f1a5 231=head1 Testing
bdab33d1 232
5438d4b8
Z
233XXX Any significant changes to the testing of a freshly built perl should be
234listed here. Changes which create B<new> files in F<t/> go here as do any
235large changes to the testing harness (e.g. when parallel testing was added).
236Changes to existing files in F<t/> aren't worth summarising, although the bugs
237that they represent may be covered elsewhere.
f5938650 238
5438d4b8 239[ List each test improvement as a =item entry ]
1fcb0052 240
5438d4b8 241=over 4
1fcb0052 242
b908e258
Z
243=item *
244
5438d4b8 245XXX
b908e258 246
f5938650 247=back
2fbb14a0 248
0890f1a5 249=head1 Platform Support
975dff8c 250
5438d4b8 251XXX Any changes to platform support should be listed in the sections below.
6693394d 252
5438d4b8
Z
253[ Within the sections, list each platform as a =item entry with specific
254changes as paragraphs below it. ]
6693394d 255
5438d4b8 256=head2 New Platforms
1fcb0052 257
5438d4b8
Z
258XXX List any platforms that this version of perl compiles on, that previous
259versions did not. These will either be enabled by new files in the F<hints/>
260directories, or new subdirectories and F<README> files at the top level of the
261source tree.
6693394d 262
0890f1a5 263=over 4
f5938650 264
5438d4b8 265=item XXX-some-platform
c62f68e3 266
5438d4b8 267XXX
f5938650 268
0890f1a5 269=back
25aa614d 270
5438d4b8 271=head2 Discontinued Platforms
87d00a71 272
5438d4b8 273XXX List any platforms that this version of perl no longer compiles on.
87d00a71 274
5438d4b8 275=over 4
da507230 276
5438d4b8 277=item XXX-some-platform
fff96ff7 278
5438d4b8 279XXX
da507230 280
5438d4b8 281=back
bb3abb05 282
5438d4b8 283=head2 Platform-Specific Notes
d25b0d7b 284
5438d4b8
Z
285XXX List any changes for specific platforms. This could include configuration
286and compilation changes or changes in portability/compatibility. However,
287changes within modules for platforms should generally be listed in the
288L</Modules and Pragmata> section.
d25b0d7b 289
5438d4b8 290=over 4
4bee03f8 291
5438d4b8 292=item XXX-some-platform
4bee03f8 293
5438d4b8 294XXX
d9463c66 295
5438d4b8 296=back
d9463c66 297
5438d4b8 298=head1 Internal Changes
7c4c6e7c 299
5438d4b8
Z
300XXX Changes which affect the interface available to C<XS> code go here.
301Other significant internal changes for future core maintainers should
302be noted as well.
7c4c6e7c 303
5438d4b8 304[ List each change as a =item entry ]
777d9014 305
5438d4b8 306=over 4
95f7e41f
FC
307
308=item *
309
5438d4b8 310XXX
df5b44bd 311
5438d4b8 312=back
df5b44bd 313
5438d4b8 314=head1 Selected Bug Fixes
e22e289d 315
5438d4b8
Z
316XXX Important bug fixes in the core language are summarised here.
317Bug fixes in files in F<ext/> and F<lib/> are best summarised in
318L</Modules and Pragmata>.
7818c927 319
5438d4b8 320[ List each fix as a =item entry ]
7818c927 321
5438d4b8 322=over 4
7818c927
FC
323
324=item *
325
5438d4b8 326XXX
7818c927 327
5438d4b8 328=back
c62f68e3 329
5438d4b8 330=head1 Known Problems
c62f68e3 331
5438d4b8
Z
332XXX Descriptions of platform agnostic bugs we know we can't fix go here. Any
333tests that had to be C<TODO>ed for the release would be noted here, unless
334they were specific to a particular platform (see below).
c62f68e3 335
5438d4b8
Z
336This is a list of some significant unfixed bugs, which are regressions
337from either 5.XXX.XXX or 5.XXX.XXX.
e22e289d 338
5438d4b8 339[ List each fix as a =item entry ]
e22e289d 340
5438d4b8 341=over 4
e22e289d 342
b908e258
Z
343=item *
344
5438d4b8 345XXX
4ec40670 346
5438d4b8 347=back
4ec40670 348
5438d4b8 349=head1 Obituary
b908e258 350
5438d4b8
Z
351XXX If any significant core contributor has died, we've added a short obituary
352here.
42a91c97 353
44691e6f
AB
354=head1 Acknowledgements
355
f1c1ecab 356XXX Generate this with:
5438d4b8
Z
357
358 perl Porting/acknowledgements.pl v5.15.1..HEAD
29cf780c 359
44691e6f
AB
360=head1 Reporting Bugs
361
362If you find what you think is a bug, you might check the articles
34dc2ec0 363recently posted to the comp.lang.perl.misc newsgroup and the perl
44691e6f
AB
364bug database at http://rt.perl.org/perlbug/ . There may also be
365information at http://www.perl.org/ , the Perl Home Page.
366
367If you believe you have an unreported bug, please run the L<perlbug>
368program included with your release. Be sure to trim your bug down
369to a tiny but sufficient test case. Your bug report, along with the
370output of C<perl -V>, will be sent off to perlbug@perl.org to be
371analysed by the Perl porting team.
372
373If the bug you are reporting has security implications, which make it
374inappropriate to send to a publicly archived mailing list, then please send
34dc2ec0 375it to perl5-security-report@perl.org. This points to a closed subscription
b4707b2a
FC
376unarchived mailing list, which includes
377all the core committers, who will be able
44691e6f
AB
378to help assess the impact of issues, figure out a resolution, and help
379co-ordinate the release of patches to mitigate or fix the problem across all
34dc2ec0
DM
380platforms on which Perl is supported. Please only use this address for
381security issues in the Perl core, not for modules independently
44691e6f
AB
382distributed on CPAN.
383
384=head1 SEE ALSO
385
386The F<Changes> file for an explanation of how to view exhaustive details
387on what changed.
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