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