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