This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
d3f70651f5af7bc7062e73408c6392aeb41deb82
[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 =head2 "Escaped" colons and relative paths in PATH
37
38 On Unix systems, Perl treats any relative paths in the PATH environment
39 variable as tainted when starting a new process.  Previously, it was
40 allowing a backslash to escape a colon (unlike the OS), consequently
41 allowing relative paths to be considered safe if the PATH was set to
42 something like C</\:.>.  The check has been fixed to treat C<.> as tainted
43 in that example.
44
45 =head1 Incompatible Changes
46
47 XXX For a release on a stable branch, this section aspires to be:
48
49     There are no changes intentionally incompatible with 5.XXX.XXX
50     If any exist, they are bugs, and we request that you submit a
51     report.  See L</Reporting Bugs> below.
52
53 [ List each incompatible change as a =head2 entry ]
54
55 =head1 Deprecations
56
57 XXX Any deprecated features, syntax, modules etc. should be listed here.
58
59 =head2 Module removals
60
61 XXX Remove this section if inapplicable.
62
63 The following modules will be removed from the core distribution in a
64 future release, and will at that time need to be installed from CPAN.
65 Distributions on CPAN which require these modules will need to list them as
66 prerequisites.
67
68 The core versions of these modules will now issue C<"deprecated">-category
69 warnings to alert you to this fact.  To silence these deprecation warnings,
70 install the modules in question from CPAN.
71
72 Note that these are (with rare exceptions) fine modules that you are encouraged
73 to continue to use.  Their disinclusion from core primarily hinges on their
74 necessity to bootstrapping a fully functional, CPAN-capable Perl installation,
75 not usually on concerns over their design.
76
77 =over
78
79 =item XXX
80
81 XXX Note that deprecated modules should be listed here even if they are listed
82 as an updated module in the L</Modules and Pragmata> section.
83
84 =back
85
86 [ List each other deprecation as a =head2 entry ]
87
88 =head1 Performance Enhancements
89
90 XXX Changes which enhance performance without changing behaviour go here.
91 There may well be none in a stable release.
92
93 [ List each enhancement as a =item entry ]
94
95 =over 4
96
97 =item *
98
99 XXX
100
101 =back
102
103 =head1 Modules and Pragmata
104
105 XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
106 go here.  If Module::CoreList is updated, generate an initial draft of the
107 following sections using F<Porting/corelist-perldelta.pl>.  A paragraph summary
108 for important changes should then be added by hand.  In an ideal world,
109 dual-life modules would have a F<Changes> file that could be cribbed.
110
111 [ Within each section, list entries as a =item entry ]
112
113 =head2 New Modules and Pragmata
114
115 =over 4
116
117 =item *
118
119 XXX
120
121 =back
122
123 =head2 Updated Modules and Pragmata
124
125 =over 4
126
127 =item *
128
129 L<Filter::Simple> has been upgraded from version 0.92 to 0.93.
130
131 It no longer treats C<no MyFilter> immediately following C<use MyFilter> as
132 end-of-file.  [perl #107726]
133
134 =back
135
136 =head2 Removed Modules and Pragmata
137
138 =over 4
139
140 =item *
141
142 XXX
143
144 =back
145
146 =head1 Documentation
147
148 XXX Changes to files in F<pod/> go here.  Consider grouping entries by
149 file and be sure to link to the appropriate page, e.g. L<perlfunc>.
150
151 =head2 New Documentation
152
153 XXX Changes which create B<new> files in F<pod/> go here.
154
155 =head3 L<XXX>
156
157 XXX Description of the purpose of the new file here
158
159 =head2 Changes to Existing Documentation
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 =head3 L<perlinterp>
166
167 =over 4
168
169 =item *
170
171 L<perlinterp> has been expanded to give a more detailed example of how to
172 hunt around in the parser to how a given operator is handled.
173
174 =back
175
176 =head1 Diagnostics
177
178 The following additions or changes have been made to diagnostic output,
179 including warnings and fatal error messages.  For the complete list of
180 diagnostic messages, see L<perldiag>.
181
182 XXX New or changed warnings emitted by the core's C<C> code go here.  Also
183 include any changes in L<perldiag> that reconcile it to the C<C> code.
184
185 =head2 New Diagnostics
186
187 XXX Newly added diagnostic messages go under here, separated into New Errors
188 and New Warnings
189
190 =head3 New Errors
191
192 =over 4
193
194 =item *
195
196 XXX L<message|perldiag/"message">
197
198 =back
199
200 =head3 New Warnings
201
202 =over 4
203
204 =item *
205
206 XXX L<message|perldiag/"message">
207
208 =back
209
210 =head2 Changes to Existing Diagnostics
211
212 XXX Changes (i.e. rewording) of diagnostic messages go here
213
214 =over 4
215
216 =item *
217
218 XXX Describe change here
219
220 =back
221
222 =head1 Utility Changes
223
224 XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here.
225 Most of these are built within the directory F<utils>.
226
227 [ List utility changes as a =head2 entry for each utility and =item
228 entries for each change
229 Use L<XXX> with program names to get proper documentation linking. ]
230
231 =head2 L<XXX>
232
233 =over 4
234
235 =item *
236
237 XXX
238
239 =back
240
241 =head1 Configuration and Compilation
242
243 XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
244 go here.  Any other changes to the Perl build process should be listed here.
245 However, any platform-specific changes should be listed in the
246 L</Platform Support> section, instead.
247
248 [ List changes as a =item entry ].
249
250 =over 4
251
252 =item *
253
254 XXX
255
256 =back
257
258 =head1 Testing
259
260 XXX Any significant changes to the testing of a freshly built perl should be
261 listed here.  Changes which create B<new> files in F<t/> go here as do any
262 large changes to the testing harness (e.g. when parallel testing was added).
263 Changes to existing files in F<t/> aren't worth summarizing, although the bugs
264 that they represent may be covered elsewhere.
265
266 [ List each test improvement as a =item entry ]
267
268 =over 4
269
270 =item *
271
272 XXX
273
274 =back
275
276 =head1 Platform Support
277
278 XXX Any changes to platform support should be listed in the sections below.
279
280 [ Within the sections, list each platform as a =item entry with specific
281 changes as paragraphs below it. ]
282
283 =head2 New Platforms
284
285 XXX List any platforms that this version of perl compiles on, that previous
286 versions did not.  These will either be enabled by new files in the F<hints/>
287 directories, or new subdirectories and F<README> files at the top level of the
288 source tree.
289
290 =over 4
291
292 =item XXX-some-platform
293
294 XXX
295
296 =back
297
298 =head2 Discontinued Platforms
299
300 XXX List any platforms that this version of perl no longer compiles on.
301
302 =over 4
303
304 =item XXX-some-platform
305
306 XXX
307
308 =back
309
310 =head2 Platform-Specific Notes
311
312 XXX List any changes for specific platforms.  This could include configuration
313 and compilation changes or changes in portability/compatibility.  However,
314 changes within modules for platforms should generally be listed in the
315 L</Modules and Pragmata> section.
316
317 =over 4
318
319 =item VMS
320
321 =over 4
322
323 =item *
324
325 The path separator for the C<PERL5LIB> and C<PERLLIB> environment entries is
326 now a colon (C<:>) when running under a Unix shell. There is no change when
327 running under DCL (it's still C<|>).
328
329 =back
330
331 =back
332
333 =head1 Internal Changes
334
335 XXX Changes which affect the interface available to C<XS> code go here.  Other
336 significant internal changes for future core maintainers should be noted as
337 well.
338
339 [ List each change as a =item entry ]
340
341 =over 4
342
343 =item *
344
345 XXX
346
347 =back
348
349 =head1 Selected Bug Fixes
350
351 XXX Important bug fixes in the core language are summarized here.  Bug fixes in
352 files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>.
353
354 [ List each fix as a =item entry ]
355
356 =over 4
357
358 =item *
359
360 Invalid assignments to a reference constructor (e.g., C<\eval=time>) could
361 sometimes crash in addition to giving a syntax error.  [perl #125679]
362
363 =item *
364
365 The parser could sometimes crash if a bareword came after C<evalbytes>.
366 [perl #129196]
367
368 =item *
369
370 Autoloading via a method call would warn erroneously ("Use of inherited
371 AUTOLOAD for non-method") if there was a stub present in the package into
372 which the invocant had been blessed.  The warning is no longer emitted in
373 such circumstances.  [perl #47047]
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.25.4..HEAD
414
415 =head1 Reporting Bugs
416
417 If you find what you think is a bug, you might check the perl bug database
418 at L<https://rt.perl.org/> .  There may also be information at
419 L<http://www.perl.org/> , the Perl Home Page.
420
421 If you believe you have an unreported bug, please run the L<perlbug> program
422 included with your release.  Be sure to trim your bug down to a tiny but
423 sufficient test case.  Your bug report, along with the output of C<perl -V>,
424 will be sent off to perlbug@perl.org to be analysed by the Perl porting team.
425
426 If the bug you are reporting has security implications which make it
427 inappropriate to send to a publicly archived mailing list, then see
428 L<perlsec/SECURITY VULNERABILITY CONTACT INFORMATION>
429 for details of how to report the issue.
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