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