This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Update Term-UI to CPAN version 0.26
[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
9e9ca9d7
KW
31=head2 Add C<\p{Titlecase}> as a synonym for C<\p{Title}>
32
33This synyom is added for symmetry with the Unicode property names
34C<\p{Uppercase}> and C<\p{Lowercase}>.
35
36
d17f3dbc 37=head1 Security
17096837 38
d17f3dbc
JV
39XXX Any security-related notices go here. In particular, any security
40vulnerabilities closed should be noted here rather than in the
41L</Selected Bug Fixes> section.
e1165778 42
d17f3dbc 43[ List each security issue as a =head2 entry ]
17096837 44
d17f3dbc 45=head1 Incompatible Changes
935c8d19 46
d17f3dbc 47XXX For a release on a stable branch, this section aspires to be:
a3ab329f 48
d17f3dbc
JV
49 There are no changes intentionally incompatible with 5.XXX.XXX. If any
50 exist, they are bugs and reports are welcome.
a3ab329f 51
d17f3dbc 52[ List each incompatible change as a =head2 entry ]
6def3600 53
56ca34ca
KW
54=head2 Most C<\p{}> properties are now immune from case-insensitive matching
55
56For most Unicode properties, it doesn't make sense to have them match
57differently under C</i> case-insensitive matching than not. And doing
58so leads to unexpected results and potential security holes. For
59example
60
61 m/\p{ASCII_Hex_Digit}+/i
62
63could previously match non-ASCII characters because of the Unicode
64matching rules. There were a number of bugs in this feature until an
65earlier release in the 5.13 series. Now this release reverts, and
66removes the feature completely except for the few properties where
67people have come to expect it, namely the ones where casing is an
68integral part of their functionality, such as C<m/\p{Uppercase}/i> and
69C<m/\p{Lowercase}/i>, both of which match the exact same code points,
70namely those matched by C<m/\p{Cased}/i>. Details are in
71L<perlrecharclass/Unicode Properties>.
72
73User-defined property handlers that need to match differently under
74C</i> must change to read the new boolean parameter passed it which is
75non-zero if case-insensitive matching is in effect; 0 if not. See
76L<perluniprops/User-Defined Character Properties>.
77
d17f3dbc 78=head1 Deprecations
6def3600 79
d17f3dbc
JV
80XXX Any deprecated features, syntax, modules etc. should be listed here.
81In particular, deprecated modules should be listed here even if they are
82listed as an updated module in the L</Modules and Pragmata> section.
e8b333e6 83
d17f3dbc 84[ List each deprecation as a =head2 entry ]
e8b333e6 85
d17f3dbc 86=head1 Performance Enhancements
935c8d19 87
d17f3dbc
JV
88XXX Changes which enhance performance without changing behaviour go here. There
89may well be none in a stable release.
e1165778 90
d17f3dbc 91[ List each enhancement as a =item entry ]
f295f417 92
9f7a72d0 93=over 4
17096837 94
f295f417
FC
95=item *
96
d17f3dbc 97XXX
9c88a88b 98
d17f3dbc 99=back
9c88a88b 100
d17f3dbc 101=head1 Modules and Pragmata
b16cfc56 102
d17f3dbc
JV
103XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
104go here. If Module::CoreList is updated, generate an initial draft of the
105following sections using F<Porting/corelist-perldelta.pl>, which prints stub
106entries to STDOUT. Results can be pasted in place of the '=head2' entries
107below. A paragraph summary for important changes should then be added by hand.
108In an ideal world, dual-life modules would have a F<Changes> file that could be
109cribbed.
b16cfc56 110
d17f3dbc 111[ Within each section, list entries as a =item entry ]
8e1e0801 112
d17f3dbc 113=head2 New Modules and Pragmata
8e1e0801 114
d17f3dbc 115=over 4
4df1dffa
FC
116
117=item *
118
d17f3dbc 119XXX
4df1dffa 120
d17f3dbc 121=back
f5d41534 122
d17f3dbc 123=head2 Updated Modules and Pragmata
f5d41534 124
d17f3dbc 125=over 4
f5d41534
CBW
126
127=item *
128
f4c5852c
CBW
129C<CGI> has been upgraded from version 3.51 to 3.52
130
131=item *
132
f7f926be
CBW
133C<IPC::Cmd> has been upgraded from version 0.68 to 0.70
134
135=item *
136
44de791a
DG
137C<HTTP::Tiny> has been upgraded from version 0.009 to 0.010
138
139=item *
140
7cf8bfc0
DG
141C<Module::Build> has been upgraded from version 0.3607 to 0.3622.
142
143A notable change is the deprecation of several modules.
144Module::Build::Version has been deprecated and Module::Build now relies
145directly upon L<version>. Module::Build::ModuleInfo has been deprecated in
146favor of a standalone copy of it called L<Module::Metadata>.
147Module::Build::YAML has been deprecated in favor of L<CPAN::Meta::YAML>.
148
149=item *
150
2a856793
DG
151C<Module::Metadata> has been upgraded from version 1.000003 to 1.000004.
152
153=item *
154
34d5bd5d
DG
155C<Parse::CPAN::Meta> has been upgraded from version 1.40 to 1.4401.
156
157The latest Parse::CPAN::Meta can now read YAML or JSON files using
158L<CPAN::Meta::YAML> and L<JSON::PP>, which are now part of the Perl core.
159
160=item *
161
f31eab29
CBW
162C<Term::UI> has been upgraded from version 0.24 to 0.26
163
164=item *
165
f58b9ef1
CBW
166C<Unicode::Collate> has been upgraded from version 0.68 to 0.72
167
168This also sees the switch from using the pure-perl version of this
169module to the XS version.`
170
171=item *
172
d17f3dbc 173XXX
17096837 174
d17f3dbc 175=back
788ba0f4 176
d17f3dbc 177=head2 Removed Modules and Pragmata
98d645a7 178
d17f3dbc 179=over 4
98d645a7 180
7abec982
FC
181=item *
182
d17f3dbc 183XXX
7abec982 184
9f7a72d0 185=back
e1165778 186
9f7a72d0 187=head1 Documentation
17096837 188
d17f3dbc
JV
189XXX Changes to files in F<pod/> go here. Consider grouping entries by
190file and be sure to link to the appropriate page, e.g. L<perlfunc>.
b16cfc56 191
d17f3dbc 192=head2 New Documentation
b16cfc56 193
d17f3dbc 194XXX Changes which create B<new> files in F<pod/> go here.
b16cfc56 195
d17f3dbc 196=head3 L<XXX>
b16cfc56 197
d17f3dbc 198XXX Description of the purpose of the new file here
b16cfc56 199
d17f3dbc 200=head2 Changes to Existing Documentation
b16cfc56 201
d17f3dbc
JV
202XXX Changes which significantly change existing files in F<pod/> go here.
203However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
204section.
b16cfc56 205
04c692a8 206=head3 L<perlhack> and perlrepository
d4238815 207
9f7a72d0 208=over 4
17096837 209
d4238815
FC
210=item *
211
04c692a8
DR
212The L<perlhack> and perlrepository documents have been heavily edited and
213split up into several new documents.
214
215The L<perlhack> document is now much shorter, and focuses on the Perl 5
216development process and submitting patches to Perl. The technical content has
217been moved to several new documents, L<perlsource>, L<perlinterp>,
218L<perlhacktut>, and L<perlhacktips>. This technical content has only been
219lightly edited.
220
221The perlrepository document has been renamed to L<perlgit>. This new document
222is just a how-to on using git with the Perl source code. Any other content
223that used to be in perlrepository has been moved to perlhack.
e1165778 224
9f7a72d0 225=back
17096837 226
9f7a72d0 227=head1 Diagnostics
17096837 228
9f7a72d0
Z
229The following additions or changes have been made to diagnostic output,
230including warnings and fatal error messages. For the complete list of
231diagnostic messages, see L<perldiag>.
e1165778 232
d17f3dbc
JV
233XXX New or changed warnings emitted by the core's C<C> code go here. Also
234include any changes in L<perldiag> that reconcile it to the C<C> code.
235
236[ Within each section, list entries as a =item entry ]
237
9f7a72d0 238=head2 New Diagnostics
3a5c9134 239
d17f3dbc
JV
240XXX Newly added diagnostic messages go here
241
9f7a72d0 242=over 4
17096837 243
c2e0289e
FC
244=item *
245
d17f3dbc 246XXX
17096837 247
9f7a72d0 248=back
e6f1cc4d 249
9f7a72d0 250=head2 Changes to Existing Diagnostics
e1165778 251
d17f3dbc
JV
252XXX Changes (i.e. rewording) of diagnostic messages go here
253
9f7a72d0 254=over 4
17096837 255
e1165778
Z
256=item *
257
d17f3dbc 258XXX
17096837 259
3a5c9134
CBW
260=back
261
9f7a72d0 262=head1 Utility Changes
e1165778 263
d17f3dbc
JV
264XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go
265here. Most of these are built within the directories F<utils> and F<x2p>.
e1165778 266
d17f3dbc
JV
267[ List utility changes as a =head3 entry for each utility and =item
268entries for each change
269Use L<XXX> with program names to get proper documentation linking. ]
e1165778 270
d17f3dbc 271=head3 L<XXX>
b16cfc56
JV
272
273=over 4
274
275=item *
276
d17f3dbc 277XXX
b16cfc56
JV
278
279=back
280
d17f3dbc 281=head1 Configuration and Compilation
3a5c9134 282
d17f3dbc
JV
283XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
284go here. Any other changes to the Perl build process should be listed here.
285However, any platform-specific changes should be listed in the
286L</Platform Support> section, instead.
b16cfc56 287
d17f3dbc 288[ List changes as a =item entry ].
b16cfc56 289
d17f3dbc 290=over 4
3a5c9134 291
b16cfc56
JV
292=item *
293
d17f3dbc 294XXX
b16cfc56 295
d17f3dbc 296=back
b16cfc56 297
d17f3dbc 298=head1 Testing
b16cfc56 299
d17f3dbc
JV
300XXX Any significant changes to the testing of a freshly built perl should be
301listed here. Changes which create B<new> files in F<t/> go here as do any
302large changes to the testing harness (e.g. when parallel testing was added).
303Changes to existing files in F<t/> aren't worth summarising, although the bugs
304that they represent may be covered elsewhere.
b16cfc56 305
d17f3dbc 306[ List each test improvement as a =item entry ]
b16cfc56 307
d17f3dbc 308=over 4
b16cfc56
JV
309
310=item *
311
d17f3dbc 312XXX
b16cfc56 313
3a5c9134
CBW
314=back
315
9f7a72d0 316=head1 Platform Support
3a5c9134 317
d17f3dbc 318XXX Any changes to platform support should be listed in the sections below.
b16cfc56 319
d17f3dbc
JV
320[ Within the sections, list each platform as a =item entry with specific
321changes as paragraphs below it. ]
b16cfc56 322
d17f3dbc 323=head2 New Platforms
3a5c9134 324
d17f3dbc
JV
325XXX List any platforms that this version of perl compiles on, that previous
326versions did not. These will either be enabled by new files in the F<hints/>
327directories, or new subdirectories and F<README> files at the top level of the
328source tree.
3a5c9134 329
9f7a72d0 330=over 4
3a5c9134 331
d17f3dbc 332=item XXX-some-platform
b16cfc56 333
d17f3dbc 334XXX
b16cfc56 335
d17f3dbc 336=back
b16cfc56 337
d17f3dbc 338=head2 Discontinued Platforms
b16cfc56 339
d17f3dbc 340XXX List any platforms that this version of perl no longer compiles on.
b16cfc56 341
d17f3dbc 342=over 4
b16cfc56 343
d17f3dbc 344=item XXX-some-platform
b16cfc56 345
d17f3dbc 346XXX
b16cfc56
JV
347
348=back
349
d17f3dbc 350=head2 Platform-Specific Notes
b16cfc56 351
d17f3dbc
JV
352XXX List any changes for specific platforms. This could include configuration
353and compilation changes or changes in portability/compatibility. However,
354changes within modules for platforms should generally be listed in the
355L</Modules and Pragmata> section.
3a5c9134 356
9f7a72d0 357=over 4
3a5c9134 358
347ee86f 359=item Windows
c61b6d0f 360
347ee86f
TC
361=over 4
362
363=item *
364
365The C<test-prep> build target now depends on F<pod/perltoc.pod> to allow the
366F<t/porting/buildtoc.t> test to run successfully.
367
368=back
6d4f9cf2 369
d17f3dbc 370=back
a62b1201 371
d17f3dbc 372=head1 Internal Changes
a62b1201 373
d17f3dbc
JV
374XXX Changes which affect the interface available to C<XS> code go here.
375Other significant internal changes for future core maintainers should
376be noted as well.
b030240b 377
d17f3dbc 378[ List each test improvement as a =item entry ]
b030240b 379
d17f3dbc 380=over 4
b16cfc56 381
4dc93f40
JV
382=item *
383
d17f3dbc 384XXX
b16cfc56 385
3a5c9134
CBW
386=back
387
388=head1 Selected Bug Fixes
389
d17f3dbc
JV
390XXX Important bug fixes in the core language are summarised here.
391Bug fixes in files in F<ext/> and F<lib/> are best summarised in
392L</Modules and Pragmata>.
0c7420e7 393
d17f3dbc 394[ List each fix as a =item entry ]
0c7420e7 395
d17f3dbc 396=over 4
f3fe4ed7 397
712ef7ca
FC
398=item *
399
e40e74fe
KW
400A Unicode C<\p{}> property match in a regular rexpression pattern will
401now force Unicode rules for the rest of the regular expression
712ef7ca 402
d17f3dbc 403=back
ecede56a 404
d17f3dbc 405=head1 Known Problems
ecede56a 406
d17f3dbc
JV
407XXX Descriptions of platform agnostic bugs we know we can't fix go here. Any
408tests that had to be C<TODO>ed for the release would be noted here, unless
409they were specific to a particular platform (see below).
ecede56a 410
d17f3dbc
JV
411This is a list of some significant unfixed bugs, which are regressions
412from either 5.XXX.XXX or 5.XXX.XXX.
d4560299 413
d17f3dbc 414[ List each fix as a =item entry ]
d4560299 415
d17f3dbc 416=over 4
d4560299 417
7db1267d
KW
418=item *
419
d17f3dbc 420XXX
7db1267d 421
9f7a72d0 422=back
460c4bfb 423
d17f3dbc 424=head1 Obituary
836d5805 425
d17f3dbc
JV
426XXX If any significant core contributor has died, we've added a short obituary
427here.
3a5c9134 428
9f7a72d0 429=head1 Acknowledgements
b0c3724f 430
d17f3dbc 431XXX The list of people to thank goes here.
3a5c9134
CBW
432
433=head1 Reporting Bugs
434
435If you find what you think is a bug, you might check the articles
436recently posted to the comp.lang.perl.misc newsgroup and the perl
437bug database at http://rt.perl.org/perlbug/ . There may also be
438information at http://www.perl.org/ , the Perl Home Page.
439
440If you believe you have an unreported bug, please run the L<perlbug>
441program included with your release. Be sure to trim your bug down
442to a tiny but sufficient test case. Your bug report, along with the
443output of C<perl -V>, will be sent off to perlbug@perl.org to be
444analysed by the Perl porting team.
445
446If the bug you are reporting has security implications, which make it
447inappropriate to send to a publicly archived mailing list, then please send
448it to perl5-security-report@perl.org. This points to a closed subscription
449unarchived mailing list, which includes all the core committers, who be able
450to help assess the impact of issues, figure out a resolution, and help
451co-ordinate the release of patches to mitigate or fix the problem across all
452platforms on which Perl is supported. Please only use this address for
453security issues in the Perl core, not for modules independently
454distributed on CPAN.
455
456=head1 SEE ALSO
457
458The F<Changes> file for an explanation of how to view exhaustive details
459on what changed.
460
461The F<INSTALL> file for how to build Perl.
462
463The F<README> file for general stuff.
464
465The F<Artistic> and F<Copying> files for copyright information.
466
467=cut