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