This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
perldelta for 4ae07704fb
[perl5.git] / pod / perldelta.pod
CommitLineData
44691e6f
AB
1=encoding utf8
2
3=head1 NAME
4
5d8c8c8a
FR
5[ this is a template for a new perldelta file. Any text flagged as XXX needs
6to be processed before release. ]
7
8perldelta - what is new for perl v5.17.5
e128ab2c 9
4eabcf70 10=head1 DESCRIPTION
6db9054f 11
5d8c8c8a 12This document describes differences between the 5.17.4 release and the 5.17.5
e08634c5 13release.
6db9054f 14
5d8c8c8a
FR
15If you are upgrading from an earlier release such as 5.17.3, first read
16L<perl5174delta>, which describes differences between 5.17.3 and 5.17.4.
5faa50e9 17
5d8c8c8a 18=head1 Notice
b932b266 19
5d8c8c8a 20XXX Any important notices here
b932b266 21
5d8c8c8a 22=head1 Core Enhancements
4db91b87 23
5d8c8c8a
FR
24XXX New core language features go here. Summarize user-visible core language
25enhancements. Particularly prominent performance optimisations could go
26here, but most should go in the L</Performance Enhancements> section.
4db91b87 27
5d8c8c8a 28[ List each enhancement as a =head2 entry ]
4db91b87 29
aa170ab3
KW
30=head2 Upgrade to Unicode 6.2
31
32Perl now supports the final version of Unicode 6.2. Earlier releases in
33the 5.17 series supported Unicode 6.2 beta versions. There were no
34substantive changes in the final Unicode 6.2 version from the most
35recent beta, included in Perl 5.17.4. A list of changes from Unicode
366.1 is at L<http://www.unicode.org/versions/Unicode6.2.0>.
37
5d8c8c8a 38=head1 Security
4db91b87 39
5d8c8c8a
FR
40XXX Any security-related notices go here. In particular, any security
41vulnerabilities closed should be noted here rather than in the
42L</Selected Bug Fixes> section.
4db91b87 43
5d8c8c8a 44[ List each security issue as a =head2 entry ]
4db91b87 45
916c45d9 46=head1 Incompatible Changes
9c5f5e7a 47
5d8c8c8a 48XXX For a release on a stable branch, this section aspires to be:
4db91b87 49
5d8c8c8a
FR
50 There are no changes intentionally incompatible with 5.XXX.XXX
51 If any exist, they are bugs, and we request that you submit a
52 report. See L</Reporting Bugs> below.
4db91b87 53
5d8c8c8a 54[ List each incompatible change as a =head2 entry ]
4db91b87 55
5d8c8c8a 56=head1 Deprecations
4db91b87 57
5d8c8c8a
FR
58XXX Any deprecated features, syntax, modules etc. should be listed here. In
59particular, deprecated modules should be listed here even if they are listed as
60an updated module in the L</Modules and Pragmata> section.
4db91b87 61
5d8c8c8a 62[ List each deprecation as a =head2 entry ]
4db91b87 63
5d8c8c8a 64=head1 Performance Enhancements
45f11e9c 65
5d8c8c8a
FR
66XXX Changes which enhance performance without changing behaviour go here.
67There may well be none in a stable release.
45f11e9c 68
5d8c8c8a 69[ List each enhancement as a =item entry ]
9c5f5e7a 70
916c45d9 71=over 4
338a1057
SH
72
73=item *
74
5d8c8c8a 75XXX
0ace302a 76
5d8c8c8a 77=back
5faa50e9 78
5d8c8c8a 79=head1 Modules and Pragmata
5faa50e9 80
5d8c8c8a
FR
81XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
82go here. If Module::CoreList is updated, generate an initial draft of the
83following sections using F<Porting/corelist-perldelta.pl>, which prints stub
84entries to STDOUT. Results can be pasted in place of the '=head2' entries
85below. A paragraph summary for important changes should then be added by hand.
86In an ideal world, dual-life modules would have a F<Changes> file that could be
87cribbed.
5faa50e9 88
5d8c8c8a 89[ Within each section, list entries as a =item entry ]
5faa50e9 90
5d8c8c8a 91=head2 New Modules and Pragmata
5faa50e9 92
5d8c8c8a 93=over 4
5faa50e9
FR
94
95=item *
96
5d8c8c8a 97XXX
5faa50e9 98
916c45d9 99=back
0ace302a 100
916c45d9 101=head2 Updated Modules and Pragmata
4cc02608 102
916c45d9 103=over 4
e7b92d54
SH
104
105=item *
106
8852ba3c
SH
107L<Carp> has been upgraded from version 1.26 to 1.27. The C<longmess()> and
108C<shortmess()> functions are now documented.
109
110=item *
111
112L<ExtUtils::CBuilder> has been upgraded from version 0.280208 to 0.280209. A
113list of symbols to export can now be passed to C<link()> when on Windows, as on
114other OSes [perl #115100].
5faa50e9 115
5d8c8c8a 116=back
5f877a7f 117
5d8c8c8a 118=head2 Removed Modules and Pragmata
5f877a7f 119
5d8c8c8a 120=over 4
2a527d37
SH
121
122=item *
123
5d8c8c8a 124XXX
5faa50e9 125
5d8c8c8a 126=back
5faa50e9 127
5d8c8c8a 128=head1 Documentation
5faa50e9 129
5d8c8c8a
FR
130XXX Changes to files in F<pod/> go here. Consider grouping entries by
131file and be sure to link to the appropriate page, e.g. L<perlfunc>.
9c5f5e7a 132
5d8c8c8a 133=head2 New Documentation
5faa50e9 134
5d8c8c8a 135XXX Changes which create B<new> files in F<pod/> go here.
eebee32b 136
5d8c8c8a 137=head3 L<XXX>
eebee32b 138
5d8c8c8a 139XXX Description of the purpose of the new file here
1ea91bbe 140
5d8c8c8a 141=head2 Changes to Existing Documentation
1ea91bbe 142
5d8c8c8a
FR
143XXX Changes which significantly change existing files in F<pod/> go here.
144However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
145section.
5faa50e9 146
5d8c8c8a 147=head3 L<XXX>
5faa50e9 148
5d8c8c8a 149=over 4
1ea91bbe
FR
150
151=item *
152
5d8c8c8a 153XXX Description of the change here
5faa50e9 154
916c45d9 155=back
9c5f5e7a 156
4eabcf70 157=head1 Diagnostics
05c8f9ed 158
4eabcf70
TC
159The following additions or changes have been made to diagnostic output,
160including warnings and fatal error messages. For the complete list of
161diagnostic messages, see L<perldiag>.
ceb0881c 162
5d8c8c8a
FR
163XXX New or changed warnings emitted by the core's C<C> code go here. Also
164include any changes in L<perldiag> that reconcile it to the C<C> code.
90519d0f 165
5d8c8c8a 166=head2 New Diagnostics
4db91b87 167
5d8c8c8a
FR
168XXX Newly added diagnostic messages go under here, separated into New Errors
169and New Warnings
4db91b87 170
5d8c8c8a 171=head3 New Errors
4db91b87 172
5d8c8c8a 173=over 4
4db91b87
FC
174
175=item *
176
5d8c8c8a 177XXX L<message|perldiag/"message">
4db91b87 178
5d8c8c8a 179=back
4db91b87 180
5d8c8c8a 181=head3 New Warnings
4db91b87 182
5d8c8c8a 183=over 4
90519d0f 184
1ea91bbe
FR
185=item *
186
5d8c8c8a 187XXX L<message|perldiag/"message">
1ea91bbe 188
61174fb5 189=back
422287bf 190
916c45d9 191=head2 Changes to Existing Diagnostics
c95d4104 192
5d8c8c8a
FR
193XXX Changes (i.e. rewording) of diagnostic messages go here
194
4eabcf70 195=over 4
7ab2ea42 196
916c45d9 197=item *
7ab2ea42 198
5d8c8c8a 199XXX Describe change here
4db91b87 200
5d8c8c8a 201=back
1ea91bbe 202
5d8c8c8a 203=head1 Utility Changes
1ea91bbe 204
5d8c8c8a
FR
205XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here.
206Most of these are built within the directories F<utils> and F<x2p>.
1ea91bbe 207
5d8c8c8a
FR
208[ List utility changes as a =head3 entry for each utility and =item
209entries for each change
210Use L<XXX> with program names to get proper documentation linking. ]
1ea91bbe 211
5d8c8c8a 212=head3 L<XXX>
d7f7c515 213
916c45d9 214=over 4
afc04f16 215
b4cf37f5
FC
216=item *
217
5d8c8c8a 218XXX
b4cf37f5 219
916c45d9 220=back
b4cf37f5 221
5d8c8c8a 222=head1 Configuration and Compilation
a21a3918 223
5d8c8c8a
FR
224XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
225go here. Any other changes to the Perl build process should be listed here.
226However, any platform-specific changes should be listed in the
227L</Platform Support> section, instead.
a21a3918 228
5d8c8c8a 229[ List changes as a =item entry ].
a21a3918 230
916c45d9 231=over 4
60ca243a 232
5d8c8c8a 233=item *
eebee32b 234
5d8c8c8a 235XXX
eebee32b 236
916c45d9 237=back
d91f1bc9 238
5d8c8c8a 239=head1 Testing
d91f1bc9 240
5d8c8c8a
FR
241XXX Any significant changes to the testing of a freshly built perl should be
242listed here. Changes which create B<new> files in F<t/> go here as do any
243large changes to the testing harness (e.g. when parallel testing was added).
244Changes to existing files in F<t/> aren't worth summarizing, although the bugs
245that they represent may be covered elsewhere.
3c774534 246
5d8c8c8a 247[ List each test improvement as a =item entry ]
050862bb 248
5d8c8c8a 249=over 4
050862bb
DM
250
251=item *
252
5d8c8c8a 253XXX
050862bb 254
916c45d9 255=back
d91f1bc9 256
5d8c8c8a 257=head1 Platform Support
4db91b87 258
5d8c8c8a 259XXX Any changes to platform support should be listed in the sections below.
4db91b87 260
5d8c8c8a
FR
261[ Within the sections, list each platform as a =item entry with specific
262changes as paragraphs below it. ]
4db91b87 263
5d8c8c8a 264=head2 New Platforms
4db91b87 265
5d8c8c8a
FR
266XXX List any platforms that this version of perl compiles on, that previous
267versions did not. These will either be enabled by new files in the F<hints/>
268directories, or new subdirectories and F<README> files at the top level of the
269source tree.
4db91b87 270
5d8c8c8a 271=over 4
4db91b87 272
5d8c8c8a 273=item XXX-some-platform
4db91b87 274
5d8c8c8a 275XXX
4db91b87 276
5d8c8c8a 277=back
4db91b87 278
5d8c8c8a 279=head2 Discontinued Platforms
4db91b87 280
5d8c8c8a 281XXX List any platforms that this version of perl no longer compiles on.
4db91b87 282
5d8c8c8a 283=over 4
4db91b87 284
5d8c8c8a 285=item XXX-some-platform
4db91b87 286
5d8c8c8a 287XXX
4db91b87 288
5d8c8c8a 289=back
5faa50e9 290
5d8c8c8a 291=head2 Platform-Specific Notes
5faa50e9 292
5d8c8c8a
FR
293XXX List any changes for specific platforms. This could include configuration
294and compilation changes or changes in portability/compatibility. However,
295changes within modules for platforms should generally be listed in the
296L</Modules and Pragmata> section.
5faa50e9 297
5d8c8c8a 298=over 4
5faa50e9 299
5d8c8c8a 300=item XXX-some-platform
5faa50e9 301
5d8c8c8a 302XXX
5faa50e9 303
5d8c8c8a 304=back
5faa50e9 305
5d8c8c8a 306=head1 Internal Changes
5faa50e9 307
5d8c8c8a
FR
308XXX Changes which affect the interface available to C<XS> code go here. Other
309significant internal changes for future core maintainers should be noted as
310well.
5faa50e9 311
5d8c8c8a 312[ List each change as a =item entry ]
5faa50e9 313
5d8c8c8a 314=over 4
5faa50e9
FR
315
316=item *
317
5d8c8c8a 318XXX
d91f1bc9 319
5d8c8c8a 320=back
31c15ce5 321
5d8c8c8a 322=head1 Selected Bug Fixes
4db91b87 323
5d8c8c8a
FR
324XXX Important bug fixes in the core language are summarized here. Bug fixes in
325files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>.
4db91b87 326
5d8c8c8a 327[ List each fix as a =item entry ]
4db91b87 328
5d8c8c8a 329=over 4
4db91b87
FC
330
331=item *
332
5d8c8c8a 333XXX
4db91b87 334
5d8c8c8a 335=back
4db91b87 336
5d8c8c8a 337=head1 Known Problems
4db91b87 338
5d8c8c8a
FR
339XXX Descriptions of platform agnostic bugs we know we can't fix go here. Any
340tests that had to be C<TODO>ed for the release would be noted here. Unfixed
341platform specific bugs also go here.
4db91b87 342
5d8c8c8a 343[ List each fix as a =item entry ]
4db91b87 344
5d8c8c8a 345=over 4
4db91b87 346
45f11e9c
FC
347=item *
348
5d8c8c8a 349XXX
45f11e9c 350
916c45d9 351=back
d91f1bc9 352
5d8c8c8a 353=head1 Obituary
d91f1bc9 354
5d8c8c8a
FR
355XXX If any significant core contributor has died, we've added a short obituary
356here.
90519d0f 357
916c45d9 358=head1 Acknowledgements
05bee12a 359
5d8c8c8a
FR
360XXX Generate this with:
361
362 perl Porting/acknowledgements.pl v5.17.4..HEAD
29cf780c 363
44691e6f
AB
364=head1 Reporting Bugs
365
e08634c5
SH
366If you find what you think is a bug, you might check the articles recently
367posted to the comp.lang.perl.misc newsgroup and the perl bug database at
368http://rt.perl.org/perlbug/ . There may also be information at
369http://www.perl.org/ , the Perl Home Page.
44691e6f 370
e08634c5
SH
371If you believe you have an unreported bug, please run the L<perlbug> program
372included with your release. Be sure to trim your bug down to a tiny but
373sufficient test case. Your bug report, along with the output of C<perl -V>,
374will be sent off to perlbug@perl.org to be analysed by the Perl porting team.
44691e6f
AB
375
376If the bug you are reporting has security implications, which make it
e08634c5
SH
377inappropriate to send to a publicly archived mailing list, then please send it
378to perl5-security-report@perl.org. This points to a closed subscription
379unarchived mailing list, which includes all the core committers, who will be
380able to help assess the impact of issues, figure out a resolution, and help
f9001595 381co-ordinate the release of patches to mitigate or fix the problem across all
e08634c5
SH
382platforms on which Perl is supported. Please only use this address for
383security issues in the Perl core, not for modules independently distributed on
384CPAN.
44691e6f
AB
385
386=head1 SEE ALSO
387
e08634c5
SH
388The F<Changes> file for an explanation of how to view exhaustive details on
389what changed.
44691e6f
AB
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