This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Add perldelta entry for ExtUtils::Manifest 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.4
9
10 =head1 DESCRIPTION
11
12 This document describes differences between the 5.21.3 release and the 5.21.4
13 release.
14
15 If you are upgrading from an earlier release such as 5.21.2, first read
16 L<perl5213delta>, which describes differences between 5.21.2 and 5.21.3.
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<File::Find> has been upgraded from version 1.27 to 1.28.
127
128 C<find()> and C<finddepth()> will now warn if passed inappropriate or
129 misspelled options.
130
131 =item *
132
133 L<B::Concise> has been upgraded from version 0.992 to 0.993.
134
135 =item *
136
137 L<ExtUtils::Manifest> has been upgraded from version 1.65 to 1.66.
138 [perl #122415].
139
140 =item *
141
142 L<HTTP::Tiny> has been upgraded from version 0.047 to 0.048.
143
144 =item *
145
146 L<Module::CoreList> has been upgraded from version 5.021003 to 5.021004.
147
148 =item *
149
150 L<POSIX> has been upgraded from version 1.42 to 1.43.
151
152 =item *
153
154 L<Pod::Perldoc> has been upgraded from version 3.23 to 3.24.
155
156 =item *
157
158 L<constant> has been upgraded from version 1.31 to 1.32.
159
160 It now accepts fully-qualified constant names, allowing constants to be
161 defined in packages other than the caller.
162
163 =item *
164
165 L<threads> has been upgraded from version 1.95 to 1.96.
166
167 =back
168
169 =head2 Removed Modules and Pragmata
170
171 =over 4
172
173 =item *
174
175 XXX
176
177 =back
178
179 =head1 Documentation
180
181 XXX Changes to files in F<pod/> go here.  Consider grouping entries by
182 file and be sure to link to the appropriate page, e.g. L<perlfunc>.
183
184 =head2 New Documentation
185
186 XXX Changes which create B<new> files in F<pod/> go here.
187
188 =head3 L<XXX>
189
190 XXX Description of the purpose of the new file here
191
192 =head2 Changes to Existing Documentation
193
194 XXX Changes which significantly change existing files in F<pod/> go here.
195 However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
196 section.
197
198 =head3 L<XXX>
199
200 =over 4
201
202 =item *
203
204 XXX Description of the change here
205
206 =back
207
208 =head1 Diagnostics
209
210 The following additions or changes have been made to diagnostic output,
211 including warnings and fatal error messages.  For the complete list of
212 diagnostic messages, see L<perldiag>.
213
214 XXX New or changed warnings emitted by the core's C<C> code go here.  Also
215 include any changes in L<perldiag> that reconcile it to the C<C> code.
216
217 =head2 New Diagnostics
218
219 XXX Newly added diagnostic messages go under here, separated into New Errors
220 and New Warnings
221
222 =head3 New Errors
223
224 =over 4
225
226 =item *
227
228 XXX L<message|perldiag/"message">
229
230 =back
231
232 =head3 New Warnings
233
234 =over 4
235
236 =item *
237
238 XXX L<message|perldiag/"message">
239
240 =back
241
242 =head2 Changes to Existing Diagnostics
243
244 XXX Changes (i.e. rewording) of diagnostic messages go here
245
246 =over 4
247
248 =item *
249
250 XXX Describe change here
251
252 =back
253
254 =head1 Utility Changes
255
256 XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here.
257 Most of these are built within the directory F<utils>.
258
259 [ List utility changes as a =head2 entry for each utility and =item
260 entries for each change
261 Use L<XXX> with program names to get proper documentation linking. ]
262
263 =head2 L<XXX>
264
265 =over 4
266
267 =item *
268
269 XXX
270
271 =back
272
273 =head1 Configuration and Compilation
274
275 XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
276 go here.  Any other changes to the Perl build process should be listed here.
277 However, any platform-specific changes should be listed in the
278 L</Platform Support> section, instead.
279
280 [ List changes as a =item entry ].
281
282 =over 4
283
284 =item *
285
286 XXX
287
288 =back
289
290 =head1 Testing
291
292 XXX Any significant changes to the testing of a freshly built perl should be
293 listed here.  Changes which create B<new> files in F<t/> go here as do any
294 large changes to the testing harness (e.g. when parallel testing was added).
295 Changes to existing files in F<t/> aren't worth summarizing, although the bugs
296 that they represent may be covered elsewhere.
297
298 [ List each test improvement as a =item entry ]
299
300 =over 4
301
302 =item *
303
304 XXX
305
306 =back
307
308 =head1 Platform Support
309
310 XXX Any changes to platform support should be listed in the sections below.
311
312 [ Within the sections, list each platform as a =item entry with specific
313 changes as paragraphs below it. ]
314
315 =head2 New Platforms
316
317 XXX List any platforms that this version of perl compiles on, that previous
318 versions did not.  These will either be enabled by new files in the F<hints/>
319 directories, or new subdirectories and F<README> files at the top level of the
320 source tree.
321
322 =over 4
323
324 =item XXX-some-platform
325
326 XXX
327
328 =back
329
330 =head2 Discontinued Platforms
331
332 XXX List any platforms that this version of perl no longer compiles on.
333
334 =over 4
335
336 =item XXX-some-platform
337
338 XXX
339
340 =back
341
342 =head2 Platform-Specific Notes
343
344 XXX List any changes for specific platforms.  This could include configuration
345 and compilation changes or changes in portability/compatibility.  However,
346 changes within modules for platforms should generally be listed in the
347 L</Modules and Pragmata> section.
348
349 =over 4
350
351 =item XXX-some-platform
352
353 XXX
354
355 =back
356
357 =head1 Internal Changes
358
359 XXX Changes which affect the interface available to C<XS> code go here.  Other
360 significant internal changes for future core maintainers should be noted as
361 well.
362
363 [ List each change as a =item entry ]
364
365 =over 4
366
367 =item *
368
369 The parser no longer gets confused by C<\U=> within a double-quoted string.
370 It used to roduce a syntax error, but now compile it correctly.
371 [perl #80368]
372
373 =back
374
375 =head1 Selected Bug Fixes
376
377 XXX Important bug fixes in the core language are summarized here.  Bug fixes in
378 files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>.
379
380 [ List each fix as a =item entry ]
381
382 =over 4
383
384 =item *
385
386 XXX
387
388 =item *
389
390 Compile-time checking of constant dereferencing (e.g.,
391 C<< my_constant->() >>) has been removed, since it was not taking
392 overloading into account.  [perl #69456] [perl #122607]
393
394 =item *
395
396 Constant dereferencing now works correctly for typeglob constants.
397 Previously the glob was stringified and its name looked up.  Now the glob
398 itself is used.  [perl #69456]
399
400 =item *
401
402 When parsing a funny character ($ @ % &) followed by braces, the parser no
403 longer tries to guess whether it is a block or a hash constructor (causing
404 a syntax error when it guesses the latter), since it can only be a block.
405
406 =item *
407
408 C<undef $reference> now frees the referent immediately, instead of hanging
409 on to it until the next statement.  [perl #122556]
410
411 =item *
412
413 Various cases where the name of a sub is used (autoload, overloading, error
414 messages) used to crash for lexical subs, but have been fixed.
415
416 =item *
417
418 Bareword lookup now tries to avoid vivifying packages if it turns out the
419 bareword is not going to be a subroutine name.
420
421 =back
422
423 =head1 Known Problems
424
425 XXX Descriptions of platform agnostic bugs we know we can't fix go here.  Any
426 tests that had to be C<TODO>ed for the release would be noted here.  Unfixed
427 platform specific bugs also go here.
428
429 [ List each fix as a =item entry ]
430
431 =over 4
432
433 =item *
434
435 XXX
436
437 =back
438
439 =head1 Errata From Previous Releases
440
441 =over 4
442
443 =item *
444
445 XXX Add anything here that we forgot to add, or were mistaken about, in
446 the perldelta of a previous release.
447
448 =back
449
450 =head1 Obituary
451
452 XXX If any significant core contributor has died, we've added a short obituary
453 here.
454
455 =head1 Acknowledgements
456
457 XXX Generate this with:
458
459   perl Porting/acknowledgements.pl v5.21.3..HEAD
460
461 =head1 Reporting Bugs
462
463 If you find what you think is a bug, you might check the articles recently
464 posted to the comp.lang.perl.misc newsgroup and the perl bug database at
465 https://rt.perl.org/ .  There may also be information at
466 http://www.perl.org/ , the Perl Home Page.
467
468 If you believe you have an unreported bug, please run the L<perlbug> program
469 included with your release.  Be sure to trim your bug down to a tiny but
470 sufficient test case.  Your bug report, along with the output of C<perl -V>,
471 will be sent off to perlbug@perl.org to be analysed by the Perl porting team.
472
473 If the bug you are reporting has security implications, which make it
474 inappropriate to send to a publicly archived mailing list, then please send it
475 to perl5-security-report@perl.org.  This points to a closed subscription
476 unarchived mailing list, which includes all the core committers, who will be
477 able to help assess the impact of issues, figure out a resolution, and help
478 co-ordinate the release of patches to mitigate or fix the problem across all
479 platforms on which Perl is supported.  Please only use this address for
480 security issues in the Perl core, not for modules independently distributed on
481 CPAN.
482
483 =head1 SEE ALSO
484
485 The F<Changes> file for an explanation of how to view exhaustive details on
486 what changed.
487
488 The F<INSTALL> file for how to build Perl.
489
490 The F<README> file for general stuff.
491
492 The F<Artistic> and F<Copying> files for copyright information.
493
494 =cut