This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Update Archive-Extract to CPAN version 0.48
[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
6447e912
CBW
119C<Archive::Extract> has been upgraded from version 0.46 to 0.48
120
121=item *
122
2a1594f6
CBW
123C<CGI> has been upgraded from version 3.50 to 3.51
124
125=item *
126
b85802c5 127C<Encode> has been upgraded from version 2.40 to 2.42
50afc8f8
CBW
128
129=item *
130
f5d41534
CBW
131C<threads> has been upgraded from version 1.81_03 to 1.82
132
133=item *
134
135C<threads::shared> has been upgraded from version 1.35 to 1.36
136
137=item *
138
23046b7e 139C<Time::Local> has been upgraded from version 1.1901_01 to 1.2000.
17096837 140
9f7a72d0 141=back
e1165778 142
9f7a72d0 143=head2 Removed Modules and Pragmata
b373eab8 144
9f7a72d0 145=over 4
b373eab8
FC
146
147=item *
148
9f7a72d0 149XXX
b6ae81ab 150
9f7a72d0 151=back
ca88a729 152
9f7a72d0 153=head1 Documentation
17096837 154
9f7a72d0
Z
155XXX Changes to files in F<pod/> go here. Consider grouping entries by
156file and be sure to link to the appropriate page, e.g. L<perlfunc>.
b6ae81ab 157
9f7a72d0 158=head2 New Documentation
e1165778 159
9f7a72d0 160XXX Changes which create B<new> files in F<pod/> go here.
17096837 161
9f7a72d0 162=head3 L<XXX>
e1165778 163
9f7a72d0 164XXX Description of the purpose of the new file here
e1165778 165
9f7a72d0 166=head2 Changes to Existing Documentation
17096837 167
9f7a72d0
Z
168XXX Changes which significantly change existing files in F<pod/> go here.
169However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
170section.
e1165778 171
9f7a72d0 172=head3 L<XXX>
d4238815 173
9f7a72d0 174=over 4
17096837 175
d4238815
FC
176=item *
177
9f7a72d0 178XXX Description of the change here
e1165778 179
9f7a72d0 180=back
17096837 181
9f7a72d0 182=head1 Diagnostics
17096837 183
9f7a72d0
Z
184The following additions or changes have been made to diagnostic output,
185including warnings and fatal error messages. For the complete list of
186diagnostic messages, see L<perldiag>.
e1165778 187
9f7a72d0
Z
188XXX New or changed warnings emitted by the core's C<C> code go here. Also
189include any changes in L<perldiag> that reconcile it to the C<C> code.
68adb2b0 190
9f7a72d0 191[ Within each section, list entries as a =item entry ]
17096837 192
9f7a72d0 193=head2 New Diagnostics
3a5c9134 194
9f7a72d0 195XXX Newly added diagnostic messages go here
17096837 196
9f7a72d0 197=over 4
17096837 198
c2e0289e
FC
199=item *
200
9f7a72d0 201XXX
17096837 202
9f7a72d0 203=back
e6f1cc4d 204
9f7a72d0 205=head2 Changes to Existing Diagnostics
e1165778 206
9f7a72d0 207XXX Changes (i.e. rewording) of diagnostic messages go here
17096837 208
9f7a72d0 209=over 4
17096837 210
e1165778
Z
211=item *
212
9f7a72d0 213XXX
17096837 214
3a5c9134
CBW
215=back
216
9f7a72d0 217=head1 Utility Changes
e1165778 218
9f7a72d0
Z
219XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go
220here. Most of these are built within the directories F<utils> and F<x2p>.
e1165778 221
9f7a72d0
Z
222[ List utility changes as a =head3 entry for each utility and =item
223entries for each change
224Use L<XXX> with program names to get proper documentation linking. ]
e1165778 225
9f7a72d0 226=head3 L<XXX>
e1165778 227
9f7a72d0 228=over 4
e1165778
Z
229
230=item *
231
9f7a72d0 232XXX
e1165778 233
9f7a72d0 234=back
e1165778 235
9f7a72d0 236=head1 Configuration and Compilation
e1165778 237
9f7a72d0
Z
238XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
239go here. Any other changes to the Perl build process should be listed here.
240However, any platform-specific changes should be listed in the
241L</Platform Support> section, instead.
e1165778 242
9f7a72d0 243[ List changes as a =item entry ].
e1165778 244
9f7a72d0 245=over 4
3a5c9134
CBW
246
247=item *
248
9f7a72d0 249XXX
3a5c9134
CBW
250
251=back
252
9f7a72d0 253=head1 Testing
3a5c9134 254
9f7a72d0
Z
255XXX Any significant changes to the testing of a freshly built perl should be
256listed here. Changes which create B<new> files in F<t/> go here as do any
257large changes to the testing harness (e.g. when parallel testing was added).
258Changes to existing files in F<t/> aren't worth summarising, although the bugs
259that they represent may be covered elsewhere.
3a5c9134 260
9f7a72d0 261[ List each test improvement as a =item entry ]
3a5c9134 262
3a5c9134
CBW
263=over 4
264
265=item *
266
9f7a72d0 267XXX
3a5c9134
CBW
268
269=back
270
9f7a72d0 271=head1 Platform Support
3a5c9134 272
9f7a72d0 273XXX Any changes to platform support should be listed in the sections below.
3a5c9134 274
9f7a72d0
Z
275[ Within the sections, list each platform as a =item entry with specific
276changes as paragraphs below it. ]
3a5c9134 277
9f7a72d0 278=head2 New Platforms
3a5c9134 279
9f7a72d0
Z
280XXX List any platforms that this version of perl compiles on, that previous
281versions did not. These will either be enabled by new files in the F<hints/>
282directories, or new subdirectories and F<README> files at the top level of the
283source tree.
3a5c9134 284
3a5c9134
CBW
285=over 4
286
9f7a72d0 287=item XXX-some-platform
3a5c9134 288
9f7a72d0 289XXX
51bed910 290
3a5c9134
CBW
291=back
292
9f7a72d0
Z
293=head2 Discontinued Platforms
294
295XXX List any platforms that this version of perl no longer compiles on.
3a5c9134 296
3a5c9134
CBW
297=over 4
298
9f7a72d0 299=item XXX-some-platform
3a5c9134 300
9f7a72d0 301XXX
3a5c9134
CBW
302
303=back
304
3a5c9134
CBW
305=head2 Platform-Specific Notes
306
9f7a72d0
Z
307XXX List any changes for specific platforms. This could include configuration
308and compilation changes or changes in portability/compatibility. However,
309changes within modules for platforms should generally be listed in the
310L</Modules and Pragmata> section.
3a5c9134 311
9f7a72d0 312=over 4
3a5c9134 313
9f7a72d0 314=item XXX-some-platform
fb3a2d89 315
9f7a72d0 316XXX
fb3a2d89 317
3a5c9134
CBW
318=back
319
320=head1 Internal Changes
321
9f7a72d0
Z
322XXX Changes which affect the interface available to C<XS> code go here.
323Other significant internal changes for future core maintainers should
324be noted as well.
3a5c9134 325
9f7a72d0 326[ List each test improvement as a =item entry ]
3a5c9134 327
9f7a72d0 328=over 4
3a5c9134 329
c61b6d0f
FC
330=item *
331
0a0e3cc5
NC
332The opcode bodies for C<chop> and C<chomp> and for C<schop> and C<schomp> have
333been merged. The implementation functions C<Perl_do_chop()> and
334C<Perl_do_chomp()>, never part of the public API, have been merged and moved to
335a static function in F<pp.c>. This shrinks the perl binary slightly, and should
336not affect any code outside the core (unless it is relying on the order of side
337effects when C<chomp> is passed a I<list> of values).
c61b6d0f 338
3a5c9134
CBW
339=back
340
341=head1 Selected Bug Fixes
342
9f7a72d0
Z
343XXX Important bug fixes in the core language are summarised here.
344Bug fixes in files in F<ext/> and F<lib/> are best summarised in
345L</Modules and Pragmata>.
b373eab8 346
9f7a72d0 347[ List each fix as a =item entry ]
b373eab8 348
9f7a72d0 349=over 4
4c9d53d5 350
0c7420e7
FC
351=item *
352
9f7a72d0 353XXX
0c7420e7 354
9f7a72d0 355=back
460c4bfb 356
9f7a72d0 357=head1 Known Problems
460c4bfb 358
9f7a72d0
Z
359XXX Descriptions of platform agnostic bugs we know we can't fix go here. Any
360tests that had to be C<TODO>ed for the release would be noted here, unless
361they were specific to a particular platform (see below).
26de4ac8 362
9f7a72d0
Z
363This is a list of some significant unfixed bugs, which are regressions
364from either 5.XXX.XXX or 5.XXX.XXX.
26de4ac8 365
9f7a72d0 366[ List each fix as a =item entry ]
ab7fb400 367
9f7a72d0 368=over 4
ab7fb400 369
836d5805
Z
370=item *
371
9f7a72d0 372XXX
836d5805 373
3a5c9134
CBW
374=back
375
9f7a72d0 376=head1 Obituary
3a5c9134 377
9f7a72d0
Z
378XXX If any significant core contributor has died, we've added a short obituary
379here.
b0c3724f 380
9f7a72d0 381=head1 Acknowledgements
b0c3724f 382
9f7a72d0 383XXX The list of people to thank goes here.
3a5c9134
CBW
384
385=head1 Reporting Bugs
386
387If you find what you think is a bug, you might check the articles
388recently posted to the comp.lang.perl.misc newsgroup and the perl
389bug database at http://rt.perl.org/perlbug/ . There may also be
390information at http://www.perl.org/ , the Perl Home Page.
391
392If you believe you have an unreported bug, please run the L<perlbug>
393program included with your release. Be sure to trim your bug down
394to a tiny but sufficient test case. Your bug report, along with the
395output of C<perl -V>, will be sent off to perlbug@perl.org to be
396analysed by the Perl porting team.
397
398If the bug you are reporting has security implications, which make it
399inappropriate to send to a publicly archived mailing list, then please send
400it to perl5-security-report@perl.org. This points to a closed subscription
401unarchived mailing list, which includes all the core committers, who be able
402to help assess the impact of issues, figure out a resolution, and help
403co-ordinate the release of patches to mitigate or fix the problem across all
404platforms on which Perl is supported. Please only use this address for
405security issues in the Perl core, not for modules independently
406distributed on CPAN.
407
408=head1 SEE ALSO
409
410The F<Changes> file for an explanation of how to view exhaustive details
411on what changed.
412
413The F<INSTALL> file for how to build Perl.
414
415The F<README> file for general stuff.
416
417The F<Artistic> and F<Copying> files for copyright information.
418
419=cut