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