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