Document that POSIX::localtime needs explicit argument.
[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.27.5
9
10 =head1 DESCRIPTION
11
12 This document describes differences between the 5.27.4 release and the 5.27.5
13 release.
14
15 If you are upgrading from an earlier release such as 5.27.3, first read
16 L<perl5274delta>, which describes differences between 5.27.3 and 5.27.4.
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 an =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 The list of new and updated modules is modified automatically as part of
105 preparing a Perl release, so the only reason to manually add entries here is if
106 you're summarising the important changes in the module update. (Also, if the
107 manually-added details don't match the automatically-generated ones, the
108 release manager will have to investigate the situation carefully.)
109
110 [ Within each section, list entries as an =item entry ]
111
112 =head2 New Modules and Pragmata
113
114 =over 4
115
116 =item *
117
118 XXX
119
120 =back
121
122 =head2 Updated Modules and Pragmata
123
124 =over 4
125
126 =item *
127
128 L<XXX> has been upgraded from version A.xx to B.yy.
129
130 =back
131
132 =head2 Removed Modules and Pragmata
133
134 =over 4
135
136 =item *
137
138 XXX
139
140 =back
141
142 =head1 Documentation
143
144 XXX Changes to files in F<pod/> go here.  Consider grouping entries by
145 file and be sure to link to the appropriate page, e.g. L<perlfunc>.
146
147 =head2 New Documentation
148
149 XXX Changes which create B<new> files in F<pod/> go here.
150
151 =head3 L<XXX>
152
153 XXX Description of the purpose of the new file here
154
155 =head2 Changes to Existing Documentation
156
157 We have attempted to update the documentation to reflect the changes
158 listed in this document.  If you find any we have missed, send email
159 to L<perlbug@perl.org|mailto:perlbug@perl.org>.
160
161 XXX Changes which significantly change existing files in F<pod/> go here.
162 However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
163 section.
164
165 Additionally, the following selected changes have been made:
166
167 =head3 L<XXX>
168
169 =over 4
170
171 =item *
172
173 XXX Description of the change here
174
175 =back
176
177 =head1 Diagnostics
178
179 The following additions or changes have been made to diagnostic output,
180 including warnings and fatal error messages.  For the complete list of
181 diagnostic messages, see L<perldiag>.
182
183 XXX New or changed warnings emitted by the core's C<C> code go here.  Also
184 include any changes in L<perldiag> that reconcile it to the C<C> code.
185
186 =head2 New Diagnostics
187
188 XXX Newly added diagnostic messages go under here, separated into New Errors
189 and New Warnings
190
191 =head3 New Errors
192
193 =over 4
194
195 =item *
196
197 XXX L<message|perldiag/"message">
198
199 =back
200
201 =head3 New Warnings
202
203 =over 4
204
205 =item *
206
207 XXX L<message|perldiag/"message">
208
209 =back
210
211 =head2 Changes to Existing Diagnostics
212
213 XXX Changes (i.e. rewording) of diagnostic messages go here
214
215 =over 4
216
217 =item *
218
219 XXX Describe change here
220
221 =back
222
223 =head1 Utility Changes
224
225 XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here.
226 Most of these are built within the directory F<utils>.
227
228 [ List utility changes as a =head2 entry for each utility and =item
229 entries for each change
230 Use L<XXX> with program names to get proper documentation linking. ]
231
232 =head2 L<XXX>
233
234 =over 4
235
236 =item *
237
238 XXX
239
240 =back
241
242 =head1 Configuration and Compilation
243
244 XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
245 go here.  Any other changes to the Perl build process should be listed here.
246 However, any platform-specific changes should be listed in the
247 L</Platform Support> section, instead.
248
249 [ List changes as an =item entry ].
250
251 =over 4
252
253 =item *
254
255 XXX
256
257 =back
258
259 =head1 Testing
260
261 XXX Any significant changes to the testing of a freshly built perl should be
262 listed here.  Changes which create B<new> files in F<t/> go here as do any
263 large changes to the testing harness (e.g. when parallel testing was added).
264 Changes to existing files in F<t/> aren't worth summarizing, although the bugs
265 that they represent may be covered elsewhere.
266
267 XXX If there were no significant test changes, say this:
268
269 Tests were added and changed to reflect the other additions and changes
270 in this release.
271
272 XXX If instead there were significant changes, say this:
273
274 Tests were added and changed to reflect the other additions and
275 changes in this release.  Furthermore, these significant changes were
276 made:
277
278 [ List each test improvement as an =item entry ]
279
280 =over 4
281
282 =item *
283
284 XXX
285
286 =back
287
288 =head1 Platform Support
289
290 XXX Any changes to platform support should be listed in the sections below.
291
292 [ Within the sections, list each platform as an =item entry with specific
293 changes as paragraphs below it. ]
294
295 =head2 New Platforms
296
297 XXX List any platforms that this version of perl compiles on, that previous
298 versions did not.  These will either be enabled by new files in the F<hints/>
299 directories, or new subdirectories and F<README> files at the top level of the
300 source tree.
301
302 =over 4
303
304 =item XXX-some-platform
305
306 XXX
307
308 =back
309
310 =head2 Discontinued Platforms
311
312 XXX List any platforms that this version of perl no longer compiles on.
313
314 =over 4
315
316 =item XXX-some-platform
317
318 XXX
319
320 =back
321
322 =head2 Platform-Specific Notes
323
324 XXX List any changes for specific platforms.  This could include configuration
325 and compilation changes or changes in portability/compatibility.  However,
326 changes within modules for platforms should generally be listed in the
327 L</Modules and Pragmata> section.
328
329 =over 4
330
331 =item XXX-some-platform
332
333 XXX
334
335 =back
336
337 =head1 Internal Changes
338
339 XXX Changes which affect the interface available to C<XS> code go here.  Other
340 significant internal changes for future core maintainers should be noted as
341 well.
342
343 [ List each change as an =item entry ]
344
345 =over 4
346
347 =item *
348
349 XXX
350
351 =back
352
353 =head1 Selected Bug Fixes
354
355 XXX Important bug fixes in the core language are summarized here.  Bug fixes in
356 files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>.
357
358 [ List each fix as an =item entry ]
359
360 =over 4
361
362 =item *
363
364 XXX
365
366 =back
367
368 =head1 Known Problems
369
370 XXX Descriptions of platform agnostic bugs we know we can't fix go here.  Any
371 tests that had to be C<TODO>ed for the release would be noted here.  Unfixed
372 platform specific bugs also go here.
373
374 [ List each fix as an =item entry ]
375
376 =over 4
377
378 =item *
379
380 XXX
381
382 =back
383
384 =head1 Errata From Previous Releases
385
386 =over 4
387
388 =item *
389
390 XXX Add anything here that we forgot to add, or were mistaken about, in
391 the perldelta of a previous release.
392
393 =back
394
395 =head1 Obituary
396
397 XXX If any significant core contributor has died, we've added a short obituary
398 here.
399
400 =head1 Acknowledgements
401
402 XXX Generate this with:
403
404   perl Porting/acknowledgements.pl v5.25.5..HEAD
405
406 =head1 Reporting Bugs
407
408 If you find what you think is a bug, you might check the perl bug database
409 at L<https://rt.perl.org/> .  There may also be information at
410 L<http://www.perl.org/> , the Perl Home Page.
411
412 If you believe you have an unreported bug, please run the L<perlbug> program
413 included with your release.  Be sure to trim your bug down to a tiny but
414 sufficient test case.  Your bug report, along with the output of C<perl -V>,
415 will be sent off to perlbug@perl.org to be analysed by the Perl porting team.
416
417 If the bug you are reporting has security implications which make it
418 inappropriate to send to a publicly archived mailing list, then see
419 L<perlsec/SECURITY VULNERABILITY CONTACT INFORMATION>
420 for details of how to report the issue.
421
422 =head1 Give Thanks
423
424 If you wish to thank the Perl 5 Porters for the work we had done in Perl 5,
425 you can do so by running the C<perlthanks> program:
426
427     perlthanks
428
429 This will send an email to the Perl 5 Porters list with your show of thanks.
430
431 =head1 SEE ALSO
432
433 The F<Changes> file for an explanation of how to view exhaustive details on
434 what changed.
435
436 The F<INSTALL> file for how to build Perl.
437
438 The F<README> file for general stuff.
439
440 The F<Artistic> and F<Copying> files for copyright information.
441
442 =cut