This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
f17d64cbb924fb7e01aab4e0eae6a50dfa567d65
[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.29.5
9
10 =head1 DESCRIPTION
11
12 This document describes differences between the 5.29.4 release and the 5.29.5
13 release.
14
15 If you are upgrading from an earlier release such as 5.29.3, first read
16 L<perl5294delta>, which describes differences between 5.29.3 and 5.29.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 =head2 C<-Drv> now means something on C<-DDEBUGGING> builds
31
32 Now, adding the verbose flag (C<-Dv>) to the C<-Dr> flag turns on all
33 possible regular expression debugging.
34
35 =head1 Security
36
37 XXX Any security-related notices go here.  In particular, any security
38 vulnerabilities closed should be noted here rather than in the
39 L</Selected Bug Fixes> section.
40
41 [ List each security issue as a =head2 entry ]
42
43 =head1 Incompatible Changes
44
45 XXX For a release on a stable branch, this section aspires to be:
46
47     There are no changes intentionally incompatible with 5.XXX.XXX
48     If any exist, they are bugs, and we request that you submit a
49     report.  See L</Reporting Bugs> below.
50
51 [ List each incompatible change as a =head2 entry ]
52
53 =head1 Deprecations
54
55 XXX Any deprecated features, syntax, modules etc. should be listed here.
56
57 =head2 Module removals
58
59 XXX Remove this section if not applicable.
60
61 The following modules will be removed from the core distribution in a
62 future release, and will at that time need to be installed from CPAN.
63 Distributions on CPAN which require these modules will need to list them as
64 prerequisites.
65
66 The core versions of these modules will now issue C<"deprecated">-category
67 warnings to alert you to this fact.  To silence these deprecation warnings,
68 install the modules in question from CPAN.
69
70 Note that these are (with rare exceptions) fine modules that you are encouraged
71 to continue to use.  Their disinclusion from core primarily hinges on their
72 necessity to bootstrapping a fully functional, CPAN-capable Perl installation,
73 not usually on concerns over their design.
74
75 =over
76
77 =item XXX
78
79 XXX Note that deprecated modules should be listed here even if they are listed
80 as an updated module in the L</Modules and Pragmata> section.
81
82 =back
83
84 [ List each other deprecation as a =head2 entry ]
85
86 =head1 Performance Enhancements
87
88 XXX Changes which enhance performance without changing behaviour go here.
89 There may well be none in a stable release.
90
91 [ List each enhancement as an =item entry ]
92
93 =over 4
94
95 =item *
96
97 XXX
98
99 =back
100
101 =head1 Modules and Pragmata
102
103 XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
104 go here.  If Module::CoreList is updated, generate an initial draft of the
105 following sections using F<Porting/corelist-perldelta.pl>.  A paragraph summary
106 for important changes should then be added by hand.  In an ideal world,
107 dual-life modules would have a F<Changes> file that could be cribbed.
108
109 The list of new and updated modules is modified automatically as part of
110 preparing a Perl release, so the only reason to manually add entries here is if
111 you're summarising the important changes in the module update. (Also, if the
112 manually-added details don't match the automatically-generated ones, the
113 release manager will have to investigate the situation carefully.)
114
115 [ Within each section, list entries as an =item entry ]
116
117 =head2 New Modules and Pragmata
118
119 =over 4
120
121 =item *
122
123 XXX Remove this section if not applicable.
124
125 =back
126
127 =head2 Updated Modules and Pragmata
128
129 =over 4
130
131 =item *
132
133 L<XXX> has been upgraded from version A.xx to B.yy.
134
135 If there was something important to note about this change, include that here.
136
137 =back
138
139 =head2 Removed Modules and Pragmata
140
141 =over 4
142
143 =item *
144
145 XXX
146
147 =back
148
149 =head1 Documentation
150
151 XXX Changes to files in F<pod/> go here.  Consider grouping entries by
152 file and be sure to link to the appropriate page, e.g. L<perlfunc>.
153
154 =head2 New Documentation
155
156 XXX Changes which create B<new> files in F<pod/> go here.
157
158 =head3 L<XXX>
159
160 XXX Description of the purpose of the new file here
161
162 =head2 Changes to Existing Documentation
163
164 We have attempted to update the documentation to reflect the changes
165 listed in this document.  If you find any we have missed, send email
166 to L<perlbug@perl.org|mailto:perlbug@perl.org>.
167
168 XXX Changes which significantly change existing files in F<pod/> go here.
169 However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
170 section.
171
172 Additionally, the following selected changes have been made:
173
174 =head3 L<XXX>
175
176 =over 4
177
178 =item *
179
180 XXX Description of the change here
181
182 =back
183
184 =head1 Diagnostics
185
186 The following additions or changes have been made to diagnostic output,
187 including warnings and fatal error messages.  For the complete list of
188 diagnostic messages, see L<perldiag>.
189
190 XXX New or changed warnings emitted by the core's C<C> code go here.  Also
191 include any changes in L<perldiag> that reconcile it to the C<C> code.
192
193 =head2 New Diagnostics
194
195 XXX Newly added diagnostic messages go under here, separated into New Errors
196 and New Warnings
197
198 =head3 New Errors
199
200 =over 4
201
202 =item *
203
204 XXX L<message|perldiag/"message">
205
206 =back
207
208 =head3 New Warnings
209
210 =over 4
211
212 =item *
213
214 XXX L<message|perldiag/"message">
215
216 =back
217
218 =head2 Changes to Existing Diagnostics
219
220 XXX Changes (i.e. rewording) of diagnostic messages go here
221
222 =over 4
223
224 =item *
225
226 XXX Describe change here
227
228 =back
229
230 =head1 Utility Changes
231
232 XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here.
233 Most of these are built within the directory F<utils>.
234
235 [ List utility changes as a =head2 entry for each utility and =item
236 entries for each change
237 Use L<XXX> with program names to get proper documentation linking. ]
238
239 =head2 L<XXX>
240
241 =over 4
242
243 =item *
244
245 XXX
246
247 =back
248
249 =head1 Configuration and Compilation
250
251 XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
252 go here.  Any other changes to the Perl build process should be listed here.
253 However, any platform-specific changes should be listed in the
254 L</Platform Support> section, instead.
255
256 [ List changes as an =item entry ].
257
258 =over 4
259
260 =item *
261
262 XXX
263
264 =back
265
266 =head1 Testing
267
268 XXX Any significant changes to the testing of a freshly built perl should be
269 listed here.  Changes which create B<new> files in F<t/> go here as do any
270 large changes to the testing harness (e.g. when parallel testing was added).
271 Changes to existing files in F<t/> aren't worth summarizing, although the bugs
272 that they represent may be covered elsewhere.
273
274 XXX If there were no significant test changes, say this:
275
276 Tests were added and changed to reflect the other additions and changes
277 in this release.
278
279 XXX If instead there were significant changes, say this:
280
281 Tests were added and changed to reflect the other additions and
282 changes in this release.  Furthermore, these significant changes were
283 made:
284
285 [ List each test improvement as an =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 an =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 an =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 an =item entry ]
366
367 =over 4
368
369 =item *
370
371 XXX
372
373 =back
374
375 =head1 Known Problems
376
377 XXX Descriptions of platform agnostic bugs we know we can't fix go here.  Any
378 tests that had to be C<TODO>ed for the release would be noted here.  Unfixed
379 platform specific bugs also go here.
380
381 [ List each fix as an =item entry ]
382
383 =over 4
384
385 =item *
386
387 XXX
388
389 =back
390
391 =head1 Errata From Previous Releases
392
393 =over 4
394
395 =item *
396
397 XXX Add anything here that we forgot to add, or were mistaken about, in
398 the perldelta of a previous release.
399
400 =back
401
402 =head1 Obituary
403
404 XXX If any significant core contributor or member of the CPAN community has
405 died, add a short obituary here.
406
407 =head1 Acknowledgements
408
409 XXX Generate this with:
410
411   perl Porting/acknowledgements.pl v5.29.4..HEAD
412
413 =head1 Reporting Bugs
414
415 If you find what you think is a bug, you might check the perl bug database
416 at L<https://rt.perl.org/> .  There may also be information at
417 L<http://www.perl.org/> , the Perl Home Page.
418
419 If you believe you have an unreported bug, please run the L<perlbug> program
420 included with your release.  Be sure to trim your bug down to a tiny but
421 sufficient test case.  Your bug report, along with the output of C<perl -V>,
422 will be sent off to perlbug@perl.org to be analysed by the Perl porting team.
423
424 If the bug you are reporting has security implications which make it
425 inappropriate to send to a publicly archived mailing list, then see
426 L<perlsec/SECURITY VULNERABILITY CONTACT INFORMATION>
427 for details of how to report the issue.
428
429 =head1 Give Thanks
430
431 If you wish to thank the Perl 5 Porters for the work we had done in Perl 5,
432 you can do so by running the C<perlthanks> program:
433
434     perlthanks
435
436 This will send an email to the Perl 5 Porters list with your show of thanks.
437
438 =head1 SEE ALSO
439
440 The F<Changes> file for an explanation of how to view exhaustive details on
441 what changed.
442
443 The F<INSTALL> file for how to build Perl.
444
445 The F<README> file for general stuff.
446
447 The F<Artistic> and F<Copying> files for copyright information.
448
449 =cut