This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
perldelta for afad11a2ce
[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.21.10
9
10 =head1 DESCRIPTION
11
12 This document describes differences between the 5.21.9 release and the 5.21.10
13 release.
14
15 If you are upgrading from an earlier release such as 5.21.8, first read
16 L<perl5219delta>, which describes differences between 5.21.8 and 5.21.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<B::Deparse> has been upgraded from version 1.33 to 1.34.
123
124 Deparse C<$#_> as that instead of as C<$#{_}>.  [perl #123947]
125
126 =item *
127
128 L<CPAN> has been upgraded from version 2.05 to 2.09-TRIAL.
129
130 =over 4
131
132 =item *
133
134 Add support for C<Cwd::getdcwd()> and introduce workaround for a misbehaviour
135 seen on Strawberry Perl 5.20.1.
136
137 =item *
138
139 Fix C<chdir()> after building dependencies bug.
140
141 =item *
142
143 Introduce experimental support for plugins/hooks.
144
145 =item *
146
147 Integrate the App::Cpan sources.
148
149 =item *
150
151 Do not check recursion on optional dependencies.
152
153 =item *
154
155 Sanity check META.yml to contain a hash.
156 L<[cpan #95271]|https://rt.cpan.org/Ticket/Display.html?id=95271>
157
158 =back
159
160 =item *
161
162 L<Test::Simple> has been reverted from version 1.301001_098 to 1.001014.
163
164 =item *
165
166 L<Text::Balanced> has been upgraded from version 2.02 to 2.03.
167
168 No changes to installed files other than the version bump.
169
170 =item *
171
172 L<threads> has been upgraded from version 1.96 to 1.99.
173
174 =back
175
176 =head2 Removed Modules and Pragmata
177
178 =over 4
179
180 =item *
181
182 XXX
183
184 =back
185
186 =head1 Documentation
187
188 XXX Changes to files in F<pod/> go here.  Consider grouping entries by
189 file and be sure to link to the appropriate page, e.g. L<perlfunc>.
190
191 =head2 New Documentation
192
193 XXX Changes which create B<new> files in F<pod/> go here.
194
195 =head3 L<XXX>
196
197 XXX Description of the purpose of the new file here
198
199 =head2 Changes to Existing Documentation
200
201 XXX Changes which significantly change existing files in F<pod/> go here.
202 However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
203 section.
204
205 =head3 L<XXX>
206
207 =over 4
208
209 =item *
210
211 XXX Description of the change here
212
213 =back
214
215 =head1 Diagnostics
216
217 The following additions or changes have been made to diagnostic output,
218 including warnings and fatal error messages.  For the complete list of
219 diagnostic messages, see L<perldiag>.
220
221 XXX New or changed warnings emitted by the core's C<C> code go here.  Also
222 include any changes in L<perldiag> that reconcile it to the C<C> code.
223
224 =head2 New Diagnostics
225
226 XXX Newly added diagnostic messages go under here, separated into New Errors
227 and New Warnings
228
229 =head3 New Errors
230
231 =over 4
232
233 =item *
234
235 XXX L<message|perldiag/"message">
236
237 =back
238
239 =head3 New Warnings
240
241 =over 4
242
243 =item *
244
245 XXX L<message|perldiag/"message">
246
247 =back
248
249 =head2 Changes to Existing Diagnostics
250
251 XXX Changes (i.e. rewording) of diagnostic messages go here
252
253 =over 4
254
255 =item *
256
257 XXX Describe change here
258
259 =back
260
261 =head1 Utility Changes
262
263 XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here.
264 Most of these are built within the directory F<utils>.
265
266 [ List utility changes as a =head2 entry for each utility and =item
267 entries for each change
268 Use L<XXX> with program names to get proper documentation linking. ]
269
270 =head2 L<XXX>
271
272 =over 4
273
274 =item *
275
276 XXX
277
278 =back
279
280 =head1 Configuration and Compilation
281
282 XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
283 go here.  Any other changes to the Perl build process should be listed here.
284 However, any platform-specific changes should be listed in the
285 L</Platform Support> section, instead.
286
287 [ List changes as a =item entry ].
288
289 =over 4
290
291 =item *
292
293 XXX
294
295 =back
296
297 =head1 Testing
298
299 XXX Any significant changes to the testing of a freshly built perl should be
300 listed here.  Changes which create B<new> files in F<t/> go here as do any
301 large changes to the testing harness (e.g. when parallel testing was added).
302 Changes to existing files in F<t/> aren't worth summarizing, although the bugs
303 that they represent may be covered elsewhere.
304
305 [ List each test improvement as a =item entry ]
306
307 =over 4
308
309 =item *
310
311 XXX
312
313 =back
314
315 =head1 Platform Support
316
317 XXX Any changes to platform support should be listed in the sections below.
318
319 [ Within the sections, list each platform as a =item entry with specific
320 changes as paragraphs below it. ]
321
322 =head2 New Platforms
323
324 XXX List any platforms that this version of perl compiles on, that previous
325 versions did not.  These will either be enabled by new files in the F<hints/>
326 directories, or new subdirectories and F<README> files at the top level of the
327 source tree.
328
329 =over 4
330
331 =item XXX-some-platform
332
333 XXX
334
335 =back
336
337 =head2 Discontinued Platforms
338
339 XXX List any platforms that this version of perl no longer compiles on.
340
341 =over 4
342
343 =item XXX-some-platform
344
345 XXX
346
347 =back
348
349 =head2 Platform-Specific Notes
350
351 XXX List any changes for specific platforms.  This could include configuration
352 and compilation changes or changes in portability/compatibility.  However,
353 changes within modules for platforms should generally be listed in the
354 L</Modules and Pragmata> section.
355
356 =over 4
357
358 =item XXX-some-platform
359
360 XXX
361
362 =back
363
364 =head1 Internal Changes
365
366 XXX Changes which affect the interface available to C<XS> code go here.  Other
367 significant internal changes for future core maintainers should be noted as
368 well.
369
370 [ List each change as a =item entry ]
371
372 =over 4
373
374 =item *
375
376 XXX
377
378 =back
379
380 =head1 Selected Bug Fixes
381
382 XXX Important bug fixes in the core language are summarized here.  Bug fixes in
383 files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>.
384
385 [ List each fix as a =item entry ]
386
387 =over 4
388
389 =item *
390
391 Repeated global pattern matches in scalar context on large tainted
392 strings were exponentially slow depending on the current match
393 position in the string. [perl #123202]
394
395 =back
396
397 =head1 Known Problems
398
399 XXX Descriptions of platform agnostic bugs we know we can't fix go here.  Any
400 tests that had to be C<TODO>ed for the release would be noted here.  Unfixed
401 platform specific bugs also go here.
402
403 [ List each fix as a =item entry ]
404
405 =over 4
406
407 =item *
408
409 XXX
410
411 =back
412
413 =head1 Errata From Previous Releases
414
415 =over 4
416
417 =item *
418
419 XXX Add anything here that we forgot to add, or were mistaken about, in
420 the perldelta of a previous release.
421
422 =back
423
424 =head1 Obituary
425
426 XXX If any significant core contributor has died, we've added a short obituary
427 here.
428
429 =head1 Acknowledgements
430
431 XXX Generate this with:
432
433   perl Porting/acknowledgements.pl v5.21.9..HEAD
434
435 =head1 Reporting Bugs
436
437 If you find what you think is a bug, you might check the articles recently
438 posted to the comp.lang.perl.misc newsgroup and the perl bug database at
439 https://rt.perl.org/ .  There may also be information at
440 http://www.perl.org/ , the Perl Home Page.
441
442 If you believe you have an unreported bug, please run the L<perlbug> program
443 included with your release.  Be sure to trim your bug down to a tiny but
444 sufficient test case.  Your bug report, along with the output of C<perl -V>,
445 will be sent off to perlbug@perl.org to be analysed by the Perl porting team.
446
447 If the bug you are reporting has security implications, which make it
448 inappropriate to send to a publicly archived mailing list, then please send it
449 to perl5-security-report@perl.org.  This points to a closed subscription
450 unarchived mailing list, which includes all the core committers, who will be
451 able to help assess the impact of issues, figure out a resolution, and help
452 co-ordinate the release of patches to mitigate or fix the problem across all
453 platforms on which Perl is supported.  Please only use this address for
454 security issues in the Perl core, not for modules independently distributed on
455 CPAN.
456
457 =head1 SEE ALSO
458
459 The F<Changes> file for an explanation of how to view exhaustive details on
460 what changed.
461
462 The F<INSTALL> file for how to build Perl.
463
464 The F<README> file for general stuff.
465
466 The F<Artistic> and F<Copying> files for copyright information.
467
468 =cut