This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
290a14dc05ee0ad9623a5207779f8ec087622d75
[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.10
9
10 =head1 DESCRIPTION
11
12 This document describes differences between the 5.25.9 release and the 5.25.10
13 release.
14
15 If you are upgrading from an earlier release such as 5.25.8, first read
16 L<perl5259delta>, which describes differences between 5.25.8 and 5.25.9.
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 =back
125
126 =head2 Removed Modules and Pragmata
127
128 =over 4
129
130 =item *
131
132 XXX
133
134 =back
135
136 =head1 Documentation
137
138 XXX Changes to files in F<pod/> go here.  Consider grouping entries by
139 file and be sure to link to the appropriate page, e.g. L<perlfunc>.
140
141 =head2 New Documentation
142
143 XXX Changes which create B<new> files in F<pod/> go here.
144
145 =head3 L<XXX>
146
147 XXX Description of the purpose of the new file here
148
149 =head2 Changes to Existing Documentation
150
151 XXX Changes which significantly change existing files in F<pod/> go here.
152 However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
153 section.
154
155 =head3 L<XXX>
156
157 =over 4
158
159 =item *
160
161 XXX Description of the change here
162
163 =back
164
165 =head1 Diagnostics
166
167 The following additions or changes have been made to diagnostic output,
168 including warnings and fatal error messages.  For the complete list of
169 diagnostic messages, see L<perldiag>.
170
171 XXX New or changed warnings emitted by the core's C<C> code go here.  Also
172 include any changes in L<perldiag> that reconcile it to the C<C> code.
173
174 =head2 New Diagnostics
175
176 XXX Newly added diagnostic messages go under here, separated into New Errors
177 and New Warnings
178
179 =head3 New Errors
180
181 =over 4
182
183 =item *
184
185 XXX L<message|perldiag/"message">
186
187 =back
188
189 =head3 New Warnings
190
191 =over 4
192
193 =item *
194
195 XXX L<message|perldiag/"message">
196
197 =back
198
199 =head2 Changes to Existing Diagnostics
200
201 XXX Changes (i.e. rewording) of diagnostic messages go here
202
203 =over 4
204
205 =item *
206
207 Use of unassigned code point or non-standalone grapheme for a delimiter will be a fatal error starting in Perl 5.30
208
209 This was changed to drop a leading C<v> in C<v5.30>, so it uses the same
210 style as other deprecation messages.
211
212 =back
213
214 =head1 Utility Changes
215
216 XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here.
217 Most of these are built within the directory F<utils>.
218
219 [ List utility changes as a =head2 entry for each utility and =item
220 entries for each change
221 Use L<XXX> with program names to get proper documentation linking. ]
222
223 =head2 L<XXX>
224
225 =over 4
226
227 =item *
228
229 XXX
230
231 =back
232
233 =head1 Configuration and Compilation
234
235 XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
236 go here.  Any other changes to the Perl build process should be listed here.
237 However, any platform-specific changes should be listed in the
238 L</Platform Support> section, instead.
239
240 [ List changes as a =item entry ].
241
242 =over 4
243
244 =item *
245
246 XXX
247
248 =back
249
250 =head1 Testing
251
252 XXX Any significant changes to the testing of a freshly built perl should be
253 listed here.  Changes which create B<new> files in F<t/> go here as do any
254 large changes to the testing harness (e.g. when parallel testing was added).
255 Changes to existing files in F<t/> aren't worth summarizing, although the bugs
256 that they represent may be covered elsewhere.
257
258 [ List each test improvement as a =item entry ]
259
260 =over 4
261
262 =item *
263
264 XXX
265
266 =back
267
268 =head1 Platform Support
269
270 XXX Any changes to platform support should be listed in the sections below.
271
272 [ Within the sections, list each platform as a =item entry with specific
273 changes as paragraphs below it. ]
274
275 =head2 New Platforms
276
277 XXX List any platforms that this version of perl compiles on, that previous
278 versions did not.  These will either be enabled by new files in the F<hints/>
279 directories, or new subdirectories and F<README> files at the top level of the
280 source tree.
281
282 =over 4
283
284 =item XXX-some-platform
285
286 XXX
287
288 =back
289
290 =head2 Discontinued Platforms
291
292 XXX List any platforms that this version of perl no longer compiles on.
293
294 =over 4
295
296 =item XXX-some-platform
297
298 XXX
299
300 =back
301
302 =head2 Platform-Specific Notes
303
304 XXX List any changes for specific platforms.  This could include configuration
305 and compilation changes or changes in portability/compatibility.  However,
306 changes within modules for platforms should generally be listed in the
307 L</Modules and Pragmata> section.
308
309 =over 4
310
311 =item XXX-some-platform
312
313 XXX
314
315 =back
316
317 =head1 Internal Changes
318
319 XXX Changes which affect the interface available to C<XS> code go here.  Other
320 significant internal changes for future core maintainers should be noted as
321 well.
322
323 [ List each change as a =item entry ]
324
325 =over 4
326
327 =item *
328
329 The C<op_class()> API function has been added. This is like the existing
330 C<OP_CLASS()> macro, but can more accurately determine what struct an op
331 has been allocated as. For example C<OP_CLASS()> might return
332 C<OA_BASEOP_OR_UNOP> indicating that ops of this type are usually
333 allocated as an C<OP> or C<UNOP>; while <op_class()> will return
334 C<OPclass_BASEOP> or C<OPclass_UNOP> as appropriate.
335
336 =item *
337
338 The output format of the C<op_dump()> function (as used by C<perl -Dx>)
339 has changed: it now displays an "ASCII-art" tree structure, and shows more
340 low-level details about each op, such as its address and class.
341
342 =back
343
344 =head1 Selected Bug Fixes
345
346 XXX Important bug fixes in the core language are summarized here.  Bug fixes in
347 files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>.
348
349 [ List each fix as a =item entry ]
350
351 =over 4
352
353 =item *
354
355 Attempting to use the deprecated variable C<$#> as the object in an
356 indirect object method call could cause a heap use after free or
357 buffer overflow.  [perl #129274]
358
359 =item *
360
361 When checking for an indirect object method call in some rare cases
362 the parser could reallocate the line buffer but then continue to use
363 pointers to the old buffer.  [perl #129190]
364
365 =item *
366
367 Supplying a glob as the format argument to L<perlfunc/formline> would
368 cause an assertion failure.  [perl #130722]
369
370 =item *
371
372 Code like C< $value1 =~ qr/.../ ~~ $value2 > would have the match
373 converted into a qr// operator, leaving extra elements on the stack to
374 confuse any surrounding expression.  [perl #130705]
375
376 =back
377
378 =head1 Known Problems
379
380 XXX Descriptions of platform agnostic bugs we know we can't fix go here.  Any
381 tests that had to be C<TODO>ed for the release would be noted here.  Unfixed
382 platform specific bugs also go here.
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 Errata From Previous Releases
395
396 =over 4
397
398 =item *
399
400 XXX Add anything here that we forgot to add, or were mistaken about, in
401 the perldelta of a previous release.
402
403 =back
404
405 =head1 Obituary
406
407 XXX If any significant core contributor has died, we've added a short obituary
408 here.
409
410 =head1 Acknowledgements
411
412 XXX Generate this with:
413
414   perl Porting/acknowledgements.pl v5.25.5..HEAD
415
416 =head1 Reporting Bugs
417
418 If you find what you think is a bug, you might check the perl bug database
419 at L<https://rt.perl.org/> .  There may also be information at
420 L<http://www.perl.org/> , the Perl Home Page.
421
422 If you believe you have an unreported bug, please run the L<perlbug> program
423 included with your release.  Be sure to trim your bug down to a tiny but
424 sufficient test case.  Your bug report, along with the output of C<perl -V>,
425 will be sent off to perlbug@perl.org to be analysed by the Perl porting team.
426
427 If the bug you are reporting has security implications which make it
428 inappropriate to send to a publicly archived mailing list, then see
429 L<perlsec/SECURITY VULNERABILITY CONTACT INFORMATION>
430 for details of how to report the issue.
431
432 =head1 SEE ALSO
433
434 The F<Changes> file for an explanation of how to view exhaustive details on
435 what changed.
436
437 The F<INSTALL> file for how to build Perl.
438
439 The F<README> file for general stuff.
440
441 The F<Artistic> and F<Copying> files for copyright information.
442
443 =cut