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