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