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