This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
PATCH: [perl #126310] single quote UTF-8 malformation detection
[perl5.git] / pod / perldelta.pod
CommitLineData
44691e6f
AB
1=encoding utf8
2
3=head1 NAME
4
3ce6a296
S
5[ this is a template for a new perldelta file. Any text flagged as XXX needs
6to be processed before release. ]
7
8perldelta - what is new for perl v5.25.9
eabfc7bc 9
2cfe9b50 10=head1 DESCRIPTION
eabfc7bc 11
3ce6a296 12This document describes differences between the 5.25.8 release and the 5.25.9
4b8803f0 13release.
f3ed8cbf 14
3ce6a296
S
15If you are upgrading from an earlier release such as 5.25.7, first read
16L<perl5258delta>, which describes differences between 5.25.7 and 5.25.8.
17
18=head1 Notice
19
20XXX Any important notices here
8bbdbfcb 21
733dba2b 22=head1 Core Enhancements
ce6646d7 23
3ce6a296
S
24XXX New core language features go here. Summarize user-visible core language
25enhancements. Particularly prominent performance optimisations could go
26here, but most should go in the L</Performance Enhancements> section.
27
28[ List each enhancement as a =head2 entry ]
29
30=head1 Security
31
32XXX Any security-related notices go here. In particular, any security
33vulnerabilities closed should be noted here rather than in the
34L</Selected Bug Fixes> section.
35
36[ List each security issue as a =head2 entry ]
37
38=head1 Incompatible Changes
39
40XXX For a release on a stable branch, this section aspires to be:
41
42 There are no changes intentionally incompatible with 5.XXX.XXX
43 If any exist, they are bugs, and we request that you submit a
44 report. See L</Reporting Bugs> below.
45
46[ List each incompatible change as a =head2 entry ]
47
48=head1 Deprecations
49
50XXX Any deprecated features, syntax, modules etc. should be listed here.
51
52=head2 Module removals
53
54XXX Remove this section if inapplicable.
55
56The following modules will be removed from the core distribution in a
57future release, and will at that time need to be installed from CPAN.
58Distributions on CPAN which require these modules will need to list them as
59prerequisites.
60
61The core versions of these modules will now issue C<"deprecated">-category
62warnings to alert you to this fact. To silence these deprecation warnings,
63install the modules in question from CPAN.
64
65Note that these are (with rare exceptions) fine modules that you are encouraged
66to continue to use. Their disinclusion from core primarily hinges on their
67necessity to bootstrapping a fully functional, CPAN-capable Perl installation,
68not usually on concerns over their design.
eaed4a85 69
3ce6a296 70=over
eaed4a85 71
3ce6a296
S
72=item XXX
73
74XXX Note that deprecated modules should be listed here even if they are listed
75as an updated module in the L</Modules and Pragmata> section.
76
77=back
78
79[ List each other deprecation as a =head2 entry ]
eaed4a85 80
733dba2b 81=head1 Performance Enhancements
226eba01 82
3ce6a296
S
83XXX Changes which enhance performance without changing behaviour go here.
84There may well be none in a stable release.
8bbdbfcb 85
3ce6a296 86[ List each enhancement as a =item entry ]
8bbdbfcb 87
3ce6a296 88=over 4
8bbdbfcb 89
3ce6a296 90=item *
dd3d2a3f 91
3ce6a296 92XXX
dd3d2a3f 93
8bbdbfcb
CG
94=back
95
733dba2b 96=head1 Modules and Pragmata
8bbdbfcb 97
3ce6a296
S
98XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
99go here. If Module::CoreList is updated, generate an initial draft of the
100following sections using F<Porting/corelist-perldelta.pl>. A paragraph summary
101for important changes should then be added by hand. In an ideal world,
102dual-life modules would have a F<Changes> file that could be cribbed.
103
104[ Within each section, list entries as a =item entry ]
105
106=head2 New Modules and Pragmata
8bbdbfcb
CG
107
108=over 4
109
110=item *
111
3ce6a296 112XXX
8bbdbfcb 113
3ce6a296
S
114=back
115
116=head2 Updated Modules and Pragmata
ff10d69b 117
3ce6a296 118=over 4
ff10d69b 119
76ea8b6a
JK
120=item *
121
3ce6a296 122L<XXX> has been upgraded from version A.xx to B.yy.
8bbdbfcb 123
d4151a23
S
124=item *
125
59aeb939 126L<Module::CoreList> has been upgraded from version 5.20161220 to 5.20170120.
d4151a23 127
3ce6a296 128=back
8bbdbfcb 129
3ce6a296
S
130=head2 Removed Modules and Pragmata
131
132=over 4
8bbdbfcb
CG
133
134=item *
135
3ce6a296 136XXX
8bbdbfcb 137
3ce6a296 138=back
8bbdbfcb 139
3ce6a296 140=head1 Documentation
8bbdbfcb 141
3ce6a296
S
142XXX Changes to files in F<pod/> go here. Consider grouping entries by
143file and be sure to link to the appropriate page, e.g. L<perlfunc>.
8bbdbfcb 144
3ce6a296 145=head2 New Documentation
8bbdbfcb 146
3ce6a296 147XXX Changes which create B<new> files in F<pod/> go here.
8bbdbfcb 148
3ce6a296 149=head3 L<XXX>
8bbdbfcb 150
3ce6a296 151XXX Description of the purpose of the new file here
8bbdbfcb 152
3ce6a296 153=head2 Changes to Existing Documentation
8bbdbfcb 154
3ce6a296
S
155XXX Changes which significantly change existing files in F<pod/> go here.
156However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
157section.
158
159=head3 L<XXX>
8bbdbfcb 160
3ce6a296 161=over 4
8bbdbfcb 162
107db227 163=item *
8bbdbfcb 164
3ce6a296 165XXX Description of the change here
8bbdbfcb 166
3ce6a296 167=back
8bbdbfcb 168
3ce6a296 169=head1 Diagnostics
8bbdbfcb 170
3ce6a296
S
171The following additions or changes have been made to diagnostic output,
172including warnings and fatal error messages. For the complete list of
173diagnostic messages, see L<perldiag>.
174
175XXX New or changed warnings emitted by the core's C<C> code go here. Also
176include any changes in L<perldiag> that reconcile it to the C<C> code.
8c3f6b0b 177
3ce6a296
S
178=head2 New Diagnostics
179
180XXX Newly added diagnostic messages go under here, separated into New Errors
181and New Warnings
182
183=head3 New Errors
184
185=over 4
a09f502b 186
107db227 187=item *
2c4879e2 188
3ce6a296
S
189XXX L<message|perldiag/"message">
190
191=back
192
193=head3 New Warnings
194
195=over 4
8bbdbfcb
CG
196
197=item *
198
3ce6a296
S
199XXX L<message|perldiag/"message">
200
201=back
202
203=head2 Changes to Existing Diagnostics
204
205XXX Changes (i.e. rewording) of diagnostic messages go here
206
207=over 4
bd5630ab 208
107db227 209=item *
2c4879e2 210
3ce6a296
S
211XXX Describe change here
212
213=back
214
215=head1 Utility Changes
216
217XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here.
218Most of these are built within the directory F<utils>.
219
220[ List utility changes as a =head2 entry for each utility and =item
221entries for each change
222Use L<XXX> with program names to get proper documentation linking. ]
223
224=head2 L<XXX>
225
226=over 4
a09f502b 227
107db227 228=item *
8bbdbfcb 229
3ce6a296
S
230XXX
231
232=back
233
234=head1 Configuration and Compilation
235
236XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
237go here. Any other changes to the Perl build process should be listed here.
238However, any platform-specific changes should be listed in the
239L</Platform Support> section, instead.
240
241[ List changes as a =item entry ].
242
243=over 4
8bbdbfcb 244
107db227 245=item *
8bbdbfcb 246
3ce6a296
S
247XXX
248
249=back
250
251=head1 Testing
252
253XXX Any significant changes to the testing of a freshly built perl should be
254listed here. Changes which create B<new> files in F<t/> go here as do any
255large changes to the testing harness (e.g. when parallel testing was added).
256Changes to existing files in F<t/> aren't worth summarizing, although the bugs
257that they represent may be covered elsewhere.
258
259[ List each test improvement as a =item entry ]
260
261=over 4
8bbdbfcb
CG
262
263=item *
264
3ce6a296 265XXX
07cfdfcc 266
262514fd 267=back
2c4879e2 268
3ce6a296
S
269=head1 Platform Support
270
271XXX Any changes to platform support should be listed in the sections below.
272
273[ Within the sections, list each platform as a =item entry with specific
274changes as paragraphs below it. ]
275
276=head2 New Platforms
277
278XXX List any platforms that this version of perl compiles on, that previous
279versions did not. These will either be enabled by new files in the F<hints/>
280directories, or new subdirectories and F<README> files at the top level of the
281source tree.
282
283=over 4
284
285=item XXX-some-platform
286
287XXX
288
289=back
290
291=head2 Discontinued Platforms
292
293XXX List any platforms that this version of perl no longer compiles on.
294
295=over 4
296
297=item XXX-some-platform
298
299XXX
300
301=back
302
303=head2 Platform-Specific Notes
304
305XXX List any changes for specific platforms. This could include configuration
306and compilation changes or changes in portability/compatibility. However,
307changes within modules for platforms should generally be listed in the
308L</Modules and Pragmata> section.
309
310=over 4
311
312=item XXX-some-platform
313
314XXX
315
316=back
317
318=head1 Internal Changes
319
320XXX Changes which affect the interface available to C<XS> code go here. Other
321significant internal changes for future core maintainers should be noted as
322well.
323
324[ List each change as a =item entry ]
a09f502b 325
733dba2b 326=over 4
a09f502b 327
a07f6112 328=item *
a09f502b 329
86ae6e94
KW
330Calling macros like C<isALPHA_utf8> on malformed UTF-8 have issued a
331deprecation warning since Perl v5.18. They now die.
3ce6a296
S
332
333=back
334
335=head1 Selected Bug Fixes
336
337XXX Important bug fixes in the core language are summarized here. Bug fixes in
338files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>.
339
340[ List each fix as a =item entry ]
341
342=over 4
a09f502b 343
36cabe94
YO
344=item *
345
6cdc5cd8
KW
346Under C<use utf8>, the entire Perl program is now checked that the UTF-8
347is wellformed. This resolves [perl #126310].
3ce6a296
S
348
349=back
350
351=head1 Known Problems
352
353XXX Descriptions of platform agnostic bugs we know we can't fix go here. Any
354tests that had to be C<TODO>ed for the release would be noted here. Unfixed
355platform specific bugs also go here.
36cabe94 356
3ce6a296
S
357[ List each fix as a =item entry ]
358
359=over 4
360
361=item *
362
363XXX
36cabe94 364
a07f6112 365=back
7d897bd0 366
3ce6a296
S
367=head1 Errata From Previous Releases
368
369=over 4
8bbdbfcb 370
3ce6a296
S
371=item *
372
373XXX Add anything here that we forgot to add, or were mistaken about, in
374the perldelta of a previous release.
8bbdbfcb 375
3ce6a296 376=back
262514fd 377
3ce6a296 378=head1 Obituary
a6a32e96 379
3ce6a296
S
380XXX If any significant core contributor has died, we've added a short obituary
381here.
262514fd 382
3ce6a296 383=head1 Acknowledgements
226eba01 384
3ce6a296 385XXX Generate this with:
24528e8e 386
3ce6a296 387 perl Porting/acknowledgements.pl v5.25.5..HEAD
f5b73711 388
44691e6f
AB
389=head1 Reporting Bugs
390
c0ea3294
SH
391If you find what you think is a bug, you might check the perl bug database
392at L<https://rt.perl.org/> . There may also be information at
4b8803f0 393L<http://www.perl.org/> , the Perl Home Page.
44691e6f 394
e08634c5
SH
395If you believe you have an unreported bug, please run the L<perlbug> program
396included with your release. Be sure to trim your bug down to a tiny but
397sufficient test case. Your bug report, along with the output of C<perl -V>,
398will be sent off to perlbug@perl.org to be analysed by the Perl porting team.
44691e6f 399
87c118b9
DM
400If the bug you are reporting has security implications which make it
401inappropriate to send to a publicly archived mailing list, then see
c0ea3294
SH
402L<perlsec/SECURITY VULNERABILITY CONTACT INFORMATION>
403for details of how to report the issue.
44691e6f
AB
404
405=head1 SEE ALSO
406
e08634c5
SH
407The F<Changes> file for an explanation of how to view exhaustive details on
408what changed.
44691e6f
AB
409
410The F<INSTALL> file for how to build Perl.
411
412The F<README> file for general stuff.
413
414The F<Artistic> and F<Copying> files for copyright information.
415
416=cut