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