This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
[perl #38456] binmode FH, ":crlf" only modifies top crlf layer
[perl5.git] / pod / perldelta.pod
CommitLineData
3a5c9134
CBW
1=encoding utf8
2
3=head1 NAME
4
d17f3dbc
JV
5[ this is a template for a new perldelta file. Any text flagged as
6XXX needs to be processed before release. ]
15e6cdd9 7
d17f3dbc 8perldelta - what is new for perl v5.13.10
0d157ee2 9
d17f3dbc 10=head1 DESCRIPTION
b16cfc56 11
d17f3dbc
JV
12This document describes differences between the 5.XXX.XXX release and
13the 5.XXX.XXX release.
3a5c9134 14
d17f3dbc
JV
15If you are upgrading from an earlier release such as 5.YYY.YYY, first read
16L<perl5YYYdelta>, which describes differences between 5.ZZZ.ZZZ and
175.YYY.YYY.
d4560299 18
d17f3dbc 19=head1 Notice
d4560299 20
d17f3dbc 21XXX Any important notices here
d4560299 22
d17f3dbc 23=head1 Core Enhancements
d4560299 24
d17f3dbc
JV
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.
2638c0ff 28
d17f3dbc 29[ List each enhancement as a =head2 entry ]
2638c0ff 30
d17f3dbc 31=head1 Security
17096837 32
d17f3dbc
JV
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.
e1165778 36
d17f3dbc 37[ List each security issue as a =head2 entry ]
17096837 38
d17f3dbc 39=head1 Incompatible Changes
935c8d19 40
d17f3dbc 41XXX For a release on a stable branch, this section aspires to be:
a3ab329f 42
d17f3dbc
JV
43 There are no changes intentionally incompatible with 5.XXX.XXX. If any
44 exist, they are bugs and reports are welcome.
a3ab329f 45
d17f3dbc 46[ List each incompatible change as a =head2 entry ]
6def3600 47
d17f3dbc 48=head1 Deprecations
6def3600 49
d17f3dbc
JV
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.
e8b333e6 53
d17f3dbc 54[ List each deprecation as a =head2 entry ]
e8b333e6 55
d17f3dbc 56=head1 Performance Enhancements
935c8d19 57
d17f3dbc
JV
58XXX Changes which enhance performance without changing behaviour go here. There
59may well be none in a stable release.
e1165778 60
d17f3dbc 61[ List each enhancement as a =item entry ]
f295f417 62
9f7a72d0 63=over 4
17096837 64
f295f417
FC
65=item *
66
d17f3dbc 67XXX
9c88a88b 68
d17f3dbc 69=back
9c88a88b 70
d17f3dbc 71=head1 Modules and Pragmata
b16cfc56 72
d17f3dbc
JV
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.
b16cfc56 80
d17f3dbc 81[ Within each section, list entries as a =item entry ]
8e1e0801 82
d17f3dbc 83=head2 New Modules and Pragmata
8e1e0801 84
d17f3dbc 85=over 4
4df1dffa
FC
86
87=item *
88
d17f3dbc 89XXX
4df1dffa 90
d17f3dbc 91=back
f5d41534 92
d17f3dbc 93=head2 Updated Modules and Pragmata
f5d41534 94
d17f3dbc 95=over 4
f5d41534
CBW
96
97=item *
98
f4c5852c
CBW
99C<CGI> has been upgraded from version 3.51 to 3.52
100
101=item *
102
7cf8bfc0
DG
103C<Module::Build> has been upgraded from version 0.3607 to 0.3622.
104
105A notable change is the deprecation of several modules.
106Module::Build::Version has been deprecated and Module::Build now relies
107directly upon L<version>. Module::Build::ModuleInfo has been deprecated in
108favor of a standalone copy of it called L<Module::Metadata>.
109Module::Build::YAML has been deprecated in favor of L<CPAN::Meta::YAML>.
110
111=item *
112
f58b9ef1
CBW
113C<Unicode::Collate> has been upgraded from version 0.68 to 0.72
114
115This also sees the switch from using the pure-perl version of this
116module to the XS version.`
117
118=item *
119
d17f3dbc 120XXX
17096837 121
d17f3dbc 122=back
788ba0f4 123
d17f3dbc 124=head2 Removed Modules and Pragmata
98d645a7 125
d17f3dbc 126=over 4
98d645a7 127
7abec982
FC
128=item *
129
d17f3dbc 130XXX
7abec982 131
9f7a72d0 132=back
e1165778 133
9f7a72d0 134=head1 Documentation
17096837 135
d17f3dbc
JV
136XXX Changes to files in F<pod/> go here. Consider grouping entries by
137file and be sure to link to the appropriate page, e.g. L<perlfunc>.
b16cfc56 138
d17f3dbc 139=head2 New Documentation
b16cfc56 140
d17f3dbc 141XXX Changes which create B<new> files in F<pod/> go here.
b16cfc56 142
d17f3dbc 143=head3 L<XXX>
b16cfc56 144
d17f3dbc 145XXX Description of the purpose of the new file here
b16cfc56 146
d17f3dbc 147=head2 Changes to Existing Documentation
b16cfc56 148
d17f3dbc
JV
149XXX Changes which significantly change existing files in F<pod/> go here.
150However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
151section.
b16cfc56 152
d17f3dbc 153=head3 L<XXX>
d4238815 154
9f7a72d0 155=over 4
17096837 156
d4238815
FC
157=item *
158
d17f3dbc 159XXX Description of the change here
e1165778 160
9f7a72d0 161=back
17096837 162
9f7a72d0 163=head1 Diagnostics
17096837 164
9f7a72d0
Z
165The following additions or changes have been made to diagnostic output,
166including warnings and fatal error messages. For the complete list of
167diagnostic messages, see L<perldiag>.
e1165778 168
d17f3dbc
JV
169XXX New or changed warnings emitted by the core's C<C> code go here. Also
170include any changes in L<perldiag> that reconcile it to the C<C> code.
171
172[ Within each section, list entries as a =item entry ]
173
9f7a72d0 174=head2 New Diagnostics
3a5c9134 175
d17f3dbc
JV
176XXX Newly added diagnostic messages go here
177
9f7a72d0 178=over 4
17096837 179
c2e0289e
FC
180=item *
181
d17f3dbc 182XXX
17096837 183
9f7a72d0 184=back
e6f1cc4d 185
9f7a72d0 186=head2 Changes to Existing Diagnostics
e1165778 187
d17f3dbc
JV
188XXX Changes (i.e. rewording) of diagnostic messages go here
189
9f7a72d0 190=over 4
17096837 191
e1165778
Z
192=item *
193
d17f3dbc 194XXX
17096837 195
3a5c9134
CBW
196=back
197
9f7a72d0 198=head1 Utility Changes
e1165778 199
d17f3dbc
JV
200XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go
201here. Most of these are built within the directories F<utils> and F<x2p>.
e1165778 202
d17f3dbc
JV
203[ List utility changes as a =head3 entry for each utility and =item
204entries for each change
205Use L<XXX> with program names to get proper documentation linking. ]
e1165778 206
d17f3dbc 207=head3 L<XXX>
b16cfc56
JV
208
209=over 4
210
211=item *
212
d17f3dbc 213XXX
b16cfc56
JV
214
215=back
216
d17f3dbc 217=head1 Configuration and Compilation
3a5c9134 218
d17f3dbc
JV
219XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
220go here. Any other changes to the Perl build process should be listed here.
221However, any platform-specific changes should be listed in the
222L</Platform Support> section, instead.
b16cfc56 223
d17f3dbc 224[ List changes as a =item entry ].
b16cfc56 225
d17f3dbc 226=over 4
3a5c9134 227
b16cfc56
JV
228=item *
229
d17f3dbc 230XXX
b16cfc56 231
d17f3dbc 232=back
b16cfc56 233
d17f3dbc 234=head1 Testing
b16cfc56 235
d17f3dbc
JV
236XXX Any significant changes to the testing of a freshly built perl should be
237listed here. Changes which create B<new> files in F<t/> go here as do any
238large changes to the testing harness (e.g. when parallel testing was added).
239Changes to existing files in F<t/> aren't worth summarising, although the bugs
240that they represent may be covered elsewhere.
b16cfc56 241
d17f3dbc 242[ List each test improvement as a =item entry ]
b16cfc56 243
d17f3dbc 244=over 4
b16cfc56
JV
245
246=item *
247
d17f3dbc 248XXX
b16cfc56 249
3a5c9134
CBW
250=back
251
9f7a72d0 252=head1 Platform Support
3a5c9134 253
d17f3dbc 254XXX Any changes to platform support should be listed in the sections below.
b16cfc56 255
d17f3dbc
JV
256[ Within the sections, list each platform as a =item entry with specific
257changes as paragraphs below it. ]
b16cfc56 258
d17f3dbc 259=head2 New Platforms
3a5c9134 260
d17f3dbc
JV
261XXX List any platforms that this version of perl compiles on, that previous
262versions did not. These will either be enabled by new files in the F<hints/>
263directories, or new subdirectories and F<README> files at the top level of the
264source tree.
3a5c9134 265
9f7a72d0 266=over 4
3a5c9134 267
d17f3dbc 268=item XXX-some-platform
b16cfc56 269
d17f3dbc 270XXX
b16cfc56 271
d17f3dbc 272=back
b16cfc56 273
d17f3dbc 274=head2 Discontinued Platforms
b16cfc56 275
d17f3dbc 276XXX List any platforms that this version of perl no longer compiles on.
b16cfc56 277
d17f3dbc 278=over 4
b16cfc56 279
d17f3dbc 280=item XXX-some-platform
b16cfc56 281
d17f3dbc 282XXX
b16cfc56
JV
283
284=back
285
d17f3dbc 286=head2 Platform-Specific Notes
b16cfc56 287
d17f3dbc
JV
288XXX List any changes for specific platforms. This could include configuration
289and compilation changes or changes in portability/compatibility. However,
290changes within modules for platforms should generally be listed in the
291L</Modules and Pragmata> section.
3a5c9134 292
9f7a72d0 293=over 4
3a5c9134 294
d17f3dbc 295=item XXX-some-platform
c61b6d0f 296
d17f3dbc 297XXX
6d4f9cf2 298
d17f3dbc 299=back
a62b1201 300
d17f3dbc 301=head1 Internal Changes
a62b1201 302
d17f3dbc
JV
303XXX Changes which affect the interface available to C<XS> code go here.
304Other significant internal changes for future core maintainers should
305be noted as well.
b030240b 306
d17f3dbc 307[ List each test improvement as a =item entry ]
b030240b 308
d17f3dbc 309=over 4
b16cfc56 310
4dc93f40
JV
311=item *
312
d17f3dbc 313XXX
b16cfc56 314
3a5c9134
CBW
315=back
316
317=head1 Selected Bug Fixes
318
d17f3dbc
JV
319XXX Important bug fixes in the core language are summarised here.
320Bug fixes in files in F<ext/> and F<lib/> are best summarised in
321L</Modules and Pragmata>.
0c7420e7 322
d17f3dbc 323[ List each fix as a =item entry ]
0c7420e7 324
d17f3dbc 325=over 4
f3fe4ed7 326
712ef7ca
FC
327=item *
328
e40e74fe
KW
329A Unicode C<\p{}> property match in a regular rexpression pattern will
330now force Unicode rules for the rest of the regular expression
712ef7ca 331
d17f3dbc 332=back
ecede56a 333
d17f3dbc 334=head1 Known Problems
ecede56a 335
d17f3dbc
JV
336XXX Descriptions of platform agnostic bugs we know we can't fix go here. Any
337tests that had to be C<TODO>ed for the release would be noted here, unless
338they were specific to a particular platform (see below).
ecede56a 339
d17f3dbc
JV
340This is a list of some significant unfixed bugs, which are regressions
341from either 5.XXX.XXX or 5.XXX.XXX.
d4560299 342
d17f3dbc 343[ List each fix as a =item entry ]
d4560299 344
d17f3dbc 345=over 4
d4560299 346
7db1267d
KW
347=item *
348
d17f3dbc 349XXX
7db1267d 350
9f7a72d0 351=back
460c4bfb 352
d17f3dbc 353=head1 Obituary
836d5805 354
d17f3dbc
JV
355XXX If any significant core contributor has died, we've added a short obituary
356here.
3a5c9134 357
9f7a72d0 358=head1 Acknowledgements
b0c3724f 359
d17f3dbc 360XXX The list of people to thank goes here.
3a5c9134
CBW
361
362=head1 Reporting Bugs
363
364If you find what you think is a bug, you might check the articles
365recently posted to the comp.lang.perl.misc newsgroup and the perl
366bug database at http://rt.perl.org/perlbug/ . There may also be
367information at http://www.perl.org/ , the Perl Home Page.
368
369If you believe you have an unreported bug, please run the L<perlbug>
370program included with your release. Be sure to trim your bug down
371to a tiny but sufficient test case. Your bug report, along with the
372output of C<perl -V>, will be sent off to perlbug@perl.org to be
373analysed by the Perl porting team.
374
375If the bug you are reporting has security implications, which make it
376inappropriate to send to a publicly archived mailing list, then please send
377it to perl5-security-report@perl.org. This points to a closed subscription
378unarchived mailing list, which includes all the core committers, who be able
379to help assess the impact of issues, figure out a resolution, and help
380co-ordinate the release of patches to mitigate or fix the problem across all
381platforms on which Perl is supported. Please only use this address for
382security issues in the Perl core, not for modules independently
383distributed on CPAN.
384
385=head1 SEE ALSO
386
387The F<Changes> file for an explanation of how to view exhaustive details
388on what changed.
389
390The F<INSTALL> file for how to build Perl.
391
392The F<README> file for general stuff.
393
394The F<Artistic> and F<Copying> files for copyright information.
395
396=cut