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