This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
a326ead677c085980abd53a05e70abc50fada359
[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::Load::Conditional> has been upgraded from version 0.40 to 0.42
152
153 =item *
154
155 C<Module::Metadata> has been upgraded from version 1.000003 to 1.000004.
156
157 =item *
158
159 C<Parse::CPAN::Meta> has been upgraded from version 1.40 to 1.4401.
160
161 The latest Parse::CPAN::Meta can now read YAML or JSON files using
162 L<CPAN::Meta::YAML> and L<JSON::PP>, which are now part of the Perl core.
163
164 =item *
165
166 C<Term::UI> has been upgraded from version 0.24 to 0.26
167
168 =item *
169
170 C<Unicode::Collate> has been upgraded from version 0.68 to 0.72
171
172 This also sees the switch from using the pure-perl version of this
173 module to the XS version.`
174
175 =item *
176
177 XXX
178
179 =back
180
181 =head2 Removed Modules and Pragmata
182
183 =over 4
184
185 =item *
186
187 XXX
188
189 =back
190
191 =head1 Documentation
192
193 XXX Changes to files in F<pod/> go here.  Consider grouping entries by
194 file and be sure to link to the appropriate page, e.g. L<perlfunc>.
195
196 =head2 New Documentation
197
198 XXX Changes which create B<new> files in F<pod/> go here.
199
200 =head3 L<XXX>
201
202 XXX Description of the purpose of the new file here
203
204 =head2 Changes to Existing Documentation
205
206 XXX Changes which significantly change existing files in F<pod/> go here.
207 However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
208 section.
209
210 =head3 L<perlhack> and perlrepository
211
212 =over 4
213
214 =item *
215
216 The L<perlhack> and perlrepository documents have been heavily edited and
217 split up into several new documents.
218
219 The L<perlhack> document is now much shorter, and focuses on the Perl 5
220 development process and submitting patches to Perl. The technical content has
221 been moved to several new documents, L<perlsource>, L<perlinterp>,
222 L<perlhacktut>, and L<perlhacktips>. This technical content has only been
223 lightly edited.
224
225 The perlrepository document has been renamed to L<perlgit>. This new document
226 is just a how-to on using git with the Perl source code. Any other content
227 that used to be in perlrepository has been moved to perlhack.
228
229 =back
230
231 =head1 Diagnostics
232
233 The following additions or changes have been made to diagnostic output,
234 including warnings and fatal error messages.  For the complete list of
235 diagnostic messages, see L<perldiag>.
236
237 XXX New or changed warnings emitted by the core's C<C> code go here. Also
238 include any changes in L<perldiag> that reconcile it to the C<C> code.
239
240 [ Within each section, list entries as a =item entry ]
241
242 =head2 New Diagnostics
243
244 XXX Newly added diagnostic messages go here
245
246 =over 4
247
248 =item *
249
250 XXX
251
252 =back
253
254 =head2 Changes to Existing Diagnostics
255
256 XXX Changes (i.e. rewording) of diagnostic messages go here
257
258 =over 4
259
260 =item *
261
262 XXX
263
264 =back
265
266 =head1 Utility Changes
267
268 XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go
269 here. Most of these are built within the directories F<utils> and F<x2p>.
270
271 [ List utility changes as a =head3 entry for each utility and =item
272 entries for each change
273 Use L<XXX> with program names to get proper documentation linking. ]
274
275 =head3 L<XXX>
276
277 =over 4
278
279 =item *
280
281 XXX
282
283 =back
284
285 =head1 Configuration and Compilation
286
287 XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
288 go here.  Any other changes to the Perl build process should be listed here.
289 However, any platform-specific changes should be listed in the
290 L</Platform Support> section, instead.
291
292 [ List changes as a =item entry ].
293
294 =over 4
295
296 =item *
297
298 XXX
299
300 =back
301
302 =head1 Testing
303
304 XXX Any significant changes to the testing of a freshly built perl should be
305 listed here.  Changes which create B<new> files in F<t/> go here as do any
306 large changes to the testing harness (e.g. when parallel testing was added).
307 Changes to existing files in F<t/> aren't worth summarising, although the bugs
308 that they represent may be covered elsewhere.
309
310 [ List each test improvement as a =item entry ]
311
312 =over 4
313
314 =item *
315
316 XXX
317
318 =back
319
320 =head1 Platform Support
321
322 XXX Any changes to platform support should be listed in the sections below.
323
324 [ Within the sections, list each platform as a =item entry with specific
325 changes as paragraphs below it. ]
326
327 =head2 New Platforms
328
329 XXX List any platforms that this version of perl compiles on, that previous
330 versions did not. These will either be enabled by new files in the F<hints/>
331 directories, or new subdirectories and F<README> files at the top level of the
332 source tree.
333
334 =over 4
335
336 =item XXX-some-platform
337
338 XXX
339
340 =back
341
342 =head2 Discontinued Platforms
343
344 XXX List any platforms that this version of perl no longer compiles on.
345
346 =over 4
347
348 =item XXX-some-platform
349
350 XXX
351
352 =back
353
354 =head2 Platform-Specific Notes
355
356 XXX List any changes for specific platforms. This could include configuration
357 and compilation changes or changes in portability/compatibility.  However,
358 changes within modules for platforms should generally be listed in the
359 L</Modules and Pragmata> section.
360
361 =over 4
362
363 =item Windows
364
365 =over 4
366
367 =item *
368
369 The C<test-prep> build target now depends on F<pod/perltoc.pod> to allow the
370 F<t/porting/buildtoc.t> test to run successfully.
371
372 =back
373
374 =back
375
376 =head1 Internal Changes
377
378 XXX Changes which affect the interface available to C<XS> code go here.
379 Other significant internal changes for future core maintainers should
380 be noted as well.
381
382 [ List each test improvement as a =item entry ]
383
384 =over 4
385
386 =item *
387
388 XXX
389
390 =back
391
392 =head1 Selected Bug Fixes
393
394 XXX Important bug fixes in the core language are summarised here.
395 Bug fixes in files in F<ext/> and F<lib/> are best summarised in
396 L</Modules and Pragmata>.
397
398 [ List each fix as a =item entry ]
399
400 =over 4
401
402 =item *
403
404 A Unicode C<\p{}> property match in a regular rexpression pattern will
405 now force Unicode rules for the rest of the regular expression
406
407 =back
408
409 =head1 Known Problems
410
411 XXX Descriptions of platform agnostic bugs we know we can't fix go here. Any
412 tests that had to be C<TODO>ed for the release would be noted here, unless
413 they were specific to a particular platform (see below).
414
415 This is a list of some significant unfixed bugs, which are regressions
416 from either 5.XXX.XXX or 5.XXX.XXX.
417
418 [ List each fix as a =item entry ]
419
420 =over 4
421
422 =item *
423
424 XXX
425
426 =back
427
428 =head1 Obituary
429
430 XXX If any significant core contributor has died, we've added a short obituary
431 here.
432
433 =head1 Acknowledgements
434
435 XXX The list of people to thank goes here.
436
437 =head1 Reporting Bugs
438
439 If you find what you think is a bug, you might check the articles
440 recently posted to the comp.lang.perl.misc newsgroup and the perl
441 bug database at http://rt.perl.org/perlbug/ .  There may also be
442 information at http://www.perl.org/ , the Perl Home Page.
443
444 If you believe you have an unreported bug, please run the L<perlbug>
445 program included with your release.  Be sure to trim your bug down
446 to a tiny but sufficient test case.  Your bug report, along with the
447 output of C<perl -V>, will be sent off to perlbug@perl.org to be
448 analysed by the Perl porting team.
449
450 If the bug you are reporting has security implications, which make it
451 inappropriate to send to a publicly archived mailing list, then please send
452 it to perl5-security-report@perl.org. This points to a closed subscription
453 unarchived mailing list, which includes all the core committers, who be able
454 to help assess the impact of issues, figure out a resolution, and help
455 co-ordinate the release of patches to mitigate or fix the problem across all
456 platforms on which Perl is supported. Please only use this address for
457 security issues in the Perl core, not for modules independently
458 distributed on CPAN.
459
460 =head1 SEE ALSO
461
462 The F<Changes> file for an explanation of how to view exhaustive details
463 on what changed.
464
465 The F<INSTALL> file for how to build Perl.
466
467 The F<README> file for general stuff.
468
469 The F<Artistic> and F<Copying> files for copyright information.
470
471 =cut