This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
utf8_heavy.pl: Remove unused variable declaration
[perl5.git] / pod / perldelta.pod
CommitLineData
3a5c9134
CBW
1=encoding utf8
2
3=head1 NAME
4
9f7a72d0
Z
5[ this is a template for a new perldelta file. Any text flagged as
6XXX needs to be processed before release. ]
3a5c9134 7
9f7a72d0 8perldelta - what is new for perl v5.13.9
15e6cdd9 9
9f7a72d0 10=head1 DESCRIPTION
f6166f76 11
9f7a72d0
Z
12This document describes differences between the 5.13.8 release and
13the 5.13.9 release.
0d157ee2 14
9f7a72d0
Z
15If you are upgrading from an earlier release such as 5.13.7, first read
16L<perl5138delta>, which describes differences between 5.13.7 and
175.13.8.
0d157ee2 18
9f7a72d0 19=head1 Notice
0d157ee2 20
9f7a72d0 21XXX Any important notices here
0d157ee2 22
9f7a72d0 23=head1 Core Enhancements
0d157ee2 24
9f7a72d0
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.
0d157ee2 28
9f7a72d0 29[ List each enhancement as a =head2 entry ]
0d157ee2 30
9f7a72d0 31=head1 Security
0d157ee2 32
9f7a72d0
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.
bd8e866d 36
9f7a72d0 37[ List each security issue as a =head2 entry ]
bd8e866d 38
3a5c9134
CBW
39=head1 Incompatible Changes
40
9f7a72d0 41XXX For a release on a stable branch, this section aspires to be:
3a5c9134 42
9f7a72d0
Z
43 There are no changes intentionally incompatible with 5.XXX.XXX. If any
44 exist, they are bugs and reports are welcome.
3a5c9134 45
9f7a72d0 46[ List each incompatible change as a =head2 entry ]
d66e82e8 47
3a5c9134
CBW
48=head1 Deprecations
49
9f7a72d0
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.
5609d5f9 53
9f7a72d0 54[ List each deprecation as a =head2 entry ]
5609d5f9 55
9f7a72d0 56=head1 Performance Enhancements
5609d5f9 57
9f7a72d0
Z
58XXX Changes which enhance performance without changing behaviour go here. There
59may well be none in a stable release.
5609d5f9 60
9f7a72d0 61[ List each enhancement as a =item entry ]
3a5c9134
CBW
62
63=over 4
64
65=item *
66
9f7a72d0 67XXX
e1165778 68
9f7a72d0 69=back
121e1895 70
9f7a72d0 71=head1 Modules and Pragmata
2638c0ff 72
9f7a72d0
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.
2638c0ff 80
9f7a72d0 81[ Within each section, list entries as a =item entry ]
17096837 82
9f7a72d0 83=head2 New Modules and Pragmata
2638c0ff 84
9f7a72d0 85=over 4
17096837 86
e1165778
Z
87=item *
88
e8a07a12
DG
89L<CPAN::Meta::YAML> 0.002 has been added as a dual-life module. It supports a
90subset of YAML sufficient for reading and writing META.yml and MYMETA.yml files
91included with CPAN distributions or generated by the module installation
92toolchain. It should not be used for any other general YAML parsing or
93generation task.
17096837 94
935c8d19
DG
95=item *
96
6cf6332a 97L<Module::Metadata> 1.000003 has been added as a dual-life module. It gathers
e8b333e6
DG
98package and POD information from Perl module files. It is a standalone module
99based on Module::Build::ModuleInfo for use by other module installation
100toolchain components. Module::Build::ModuleInfo has been deprecated in
101favor of this module instead.
102
103=item *
104
935c8d19
DG
105L<Perl::OSType> 1.002 has been added as a dual-life module. It maps Perl
106operating system names (e.g. 'dragonfly' or 'MSWin32') to more generic types
107with standardized names (e.g. "Unix" or "Windows"). It has been refactored
108out of Module::Build and ExtUtils::CBuilder and consolidates such mappings into
109a single location for easier maintenance.
110
9f7a72d0 111=back
e1165778 112
9f7a72d0 113=head2 Updated Modules and Pragmata
f295f417 114
9f7a72d0 115=over 4
17096837 116
f295f417
FC
117=item *
118
2a1594f6
CBW
119C<CGI> has been upgraded from version 3.50 to 3.51
120
121=item *
122
b85802c5 123C<Encode> has been upgraded from version 2.40 to 2.42
50afc8f8
CBW
124
125=item *
126
f5d41534
CBW
127C<threads> has been upgraded from version 1.81_03 to 1.82
128
129=item *
130
131C<threads::shared> has been upgraded from version 1.35 to 1.36
132
133=item *
134
23046b7e 135C<Time::Local> has been upgraded from version 1.1901_01 to 1.2000.
17096837 136
9f7a72d0 137=back
e1165778 138
9f7a72d0 139=head2 Removed Modules and Pragmata
b373eab8 140
9f7a72d0 141=over 4
b373eab8
FC
142
143=item *
144
9f7a72d0 145XXX
b6ae81ab 146
9f7a72d0 147=back
ca88a729 148
9f7a72d0 149=head1 Documentation
17096837 150
9f7a72d0
Z
151XXX Changes to files in F<pod/> go here. Consider grouping entries by
152file and be sure to link to the appropriate page, e.g. L<perlfunc>.
b6ae81ab 153
9f7a72d0 154=head2 New Documentation
e1165778 155
9f7a72d0 156XXX Changes which create B<new> files in F<pod/> go here.
17096837 157
9f7a72d0 158=head3 L<XXX>
e1165778 159
9f7a72d0 160XXX Description of the purpose of the new file here
e1165778 161
9f7a72d0 162=head2 Changes to Existing Documentation
17096837 163
9f7a72d0
Z
164XXX Changes which significantly change existing files in F<pod/> go here.
165However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
166section.
e1165778 167
9f7a72d0 168=head3 L<XXX>
d4238815 169
9f7a72d0 170=over 4
17096837 171
d4238815
FC
172=item *
173
9f7a72d0 174XXX Description of the change here
e1165778 175
9f7a72d0 176=back
17096837 177
9f7a72d0 178=head1 Diagnostics
17096837 179
9f7a72d0
Z
180The following additions or changes have been made to diagnostic output,
181including warnings and fatal error messages. For the complete list of
182diagnostic messages, see L<perldiag>.
e1165778 183
9f7a72d0
Z
184XXX New or changed warnings emitted by the core's C<C> code go here. Also
185include any changes in L<perldiag> that reconcile it to the C<C> code.
68adb2b0 186
9f7a72d0 187[ Within each section, list entries as a =item entry ]
17096837 188
9f7a72d0 189=head2 New Diagnostics
3a5c9134 190
9f7a72d0 191XXX Newly added diagnostic messages go here
17096837 192
9f7a72d0 193=over 4
17096837 194
c2e0289e
FC
195=item *
196
9f7a72d0 197XXX
17096837 198
9f7a72d0 199=back
e6f1cc4d 200
9f7a72d0 201=head2 Changes to Existing Diagnostics
e1165778 202
9f7a72d0 203XXX Changes (i.e. rewording) of diagnostic messages go here
17096837 204
9f7a72d0 205=over 4
17096837 206
e1165778
Z
207=item *
208
9f7a72d0 209XXX
17096837 210
3a5c9134
CBW
211=back
212
9f7a72d0 213=head1 Utility Changes
e1165778 214
9f7a72d0
Z
215XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go
216here. Most of these are built within the directories F<utils> and F<x2p>.
e1165778 217
9f7a72d0
Z
218[ List utility changes as a =head3 entry for each utility and =item
219entries for each change
220Use L<XXX> with program names to get proper documentation linking. ]
e1165778 221
9f7a72d0 222=head3 L<XXX>
e1165778 223
9f7a72d0 224=over 4
e1165778
Z
225
226=item *
227
9f7a72d0 228XXX
e1165778 229
9f7a72d0 230=back
e1165778 231
9f7a72d0 232=head1 Configuration and Compilation
e1165778 233
9f7a72d0
Z
234XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
235go here. Any other changes to the Perl build process should be listed here.
236However, any platform-specific changes should be listed in the
237L</Platform Support> section, instead.
e1165778 238
9f7a72d0 239[ List changes as a =item entry ].
e1165778 240
9f7a72d0 241=over 4
3a5c9134
CBW
242
243=item *
244
9f7a72d0 245XXX
3a5c9134
CBW
246
247=back
248
9f7a72d0 249=head1 Testing
3a5c9134 250
9f7a72d0
Z
251XXX Any significant changes to the testing of a freshly built perl should be
252listed here. Changes which create B<new> files in F<t/> go here as do any
253large changes to the testing harness (e.g. when parallel testing was added).
254Changes to existing files in F<t/> aren't worth summarising, although the bugs
255that they represent may be covered elsewhere.
3a5c9134 256
9f7a72d0 257[ List each test improvement as a =item entry ]
3a5c9134 258
3a5c9134
CBW
259=over 4
260
261=item *
262
9f7a72d0 263XXX
3a5c9134
CBW
264
265=back
266
9f7a72d0 267=head1 Platform Support
3a5c9134 268
9f7a72d0 269XXX Any changes to platform support should be listed in the sections below.
3a5c9134 270
9f7a72d0
Z
271[ Within the sections, list each platform as a =item entry with specific
272changes as paragraphs below it. ]
3a5c9134 273
9f7a72d0 274=head2 New Platforms
3a5c9134 275
9f7a72d0
Z
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.
3a5c9134 280
3a5c9134
CBW
281=over 4
282
9f7a72d0 283=item XXX-some-platform
3a5c9134 284
9f7a72d0 285XXX
51bed910 286
3a5c9134
CBW
287=back
288
9f7a72d0
Z
289=head2 Discontinued Platforms
290
291XXX List any platforms that this version of perl no longer compiles on.
3a5c9134 292
3a5c9134
CBW
293=over 4
294
9f7a72d0 295=item XXX-some-platform
3a5c9134 296
9f7a72d0 297XXX
3a5c9134
CBW
298
299=back
300
3a5c9134
CBW
301=head2 Platform-Specific Notes
302
9f7a72d0
Z
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.
3a5c9134 307
9f7a72d0 308=over 4
3a5c9134 309
9f7a72d0 310=item XXX-some-platform
fb3a2d89 311
9f7a72d0 312XXX
fb3a2d89 313
3a5c9134
CBW
314=back
315
316=head1 Internal Changes
317
9f7a72d0
Z
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.
3a5c9134 321
9f7a72d0 322[ List each test improvement as a =item entry ]
3a5c9134 323
9f7a72d0 324=over 4
3a5c9134 325
c61b6d0f
FC
326=item *
327
0a0e3cc5
NC
328The opcode bodies for C<chop> and C<chomp> and for C<schop> and C<schomp> have
329been merged. The implementation functions C<Perl_do_chop()> and
330C<Perl_do_chomp()>, never part of the public API, have been merged and moved to
331a static function in F<pp.c>. This shrinks the perl binary slightly, and should
332not affect any code outside the core (unless it is relying on the order of side
333effects when C<chomp> is passed a I<list> of values).
c61b6d0f 334
3a5c9134
CBW
335=back
336
337=head1 Selected Bug Fixes
338
9f7a72d0
Z
339XXX Important bug fixes in the core language are summarised here.
340Bug fixes in files in F<ext/> and F<lib/> are best summarised in
341L</Modules and Pragmata>.
b373eab8 342
9f7a72d0 343[ List each fix as a =item entry ]
b373eab8 344
9f7a72d0 345=over 4
4c9d53d5 346
0c7420e7
FC
347=item *
348
9f7a72d0 349XXX
0c7420e7 350
9f7a72d0 351=back
460c4bfb 352
9f7a72d0 353=head1 Known Problems
460c4bfb 354
9f7a72d0
Z
355XXX Descriptions of platform agnostic bugs we know we can't fix go here. Any
356tests that had to be C<TODO>ed for the release would be noted here, unless
357they were specific to a particular platform (see below).
26de4ac8 358
9f7a72d0
Z
359This is a list of some significant unfixed bugs, which are regressions
360from either 5.XXX.XXX or 5.XXX.XXX.
26de4ac8 361
9f7a72d0 362[ List each fix as a =item entry ]
ab7fb400 363
9f7a72d0 364=over 4
ab7fb400 365
836d5805
Z
366=item *
367
9f7a72d0 368XXX
836d5805 369
3a5c9134
CBW
370=back
371
9f7a72d0 372=head1 Obituary
3a5c9134 373
9f7a72d0
Z
374XXX If any significant core contributor has died, we've added a short obituary
375here.
b0c3724f 376
9f7a72d0 377=head1 Acknowledgements
b0c3724f 378
9f7a72d0 379XXX The list of people to thank goes here.
3a5c9134
CBW
380
381=head1 Reporting Bugs
382
383If you find what you think is a bug, you might check the articles
384recently posted to the comp.lang.perl.misc newsgroup and the perl
385bug database at http://rt.perl.org/perlbug/ . There may also be
386information at http://www.perl.org/ , the Perl Home Page.
387
388If you believe you have an unreported bug, please run the L<perlbug>
389program included with your release. Be sure to trim your bug down
390to a tiny but sufficient test case. Your bug report, along with the
391output of C<perl -V>, will be sent off to perlbug@perl.org to be
392analysed by the Perl porting team.
393
394If the bug you are reporting has security implications, which make it
395inappropriate to send to a publicly archived mailing list, then please send
396it to perl5-security-report@perl.org. This points to a closed subscription
397unarchived mailing list, which includes all the core committers, who be able
398to help assess the impact of issues, figure out a resolution, and help
399co-ordinate the release of patches to mitigate or fix the problem across all
400platforms on which Perl is supported. Please only use this address for
401security issues in the Perl core, not for modules independently
402distributed on CPAN.
403
404=head1 SEE ALSO
405
406The F<Changes> file for an explanation of how to view exhaustive details
407on what changed.
408
409The F<INSTALL> file for how to build Perl.
410
411The F<README> file for general stuff.
412
413The F<Artistic> and F<Copying> files for copyright information.
414
415=cut