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