This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Ignore mismatched versions between Carp and Carp::Heavy if the version discrepancy...
[perl5.git] / pod / perldelta.pod
... / ...
CommitLineData
1=encoding utf8
2
3=head1 NAME
4
5[ this is a template for a new perldelta file. Any text flagged as XXX needs
6to be processed before release. ]
7
8perldelta - what is new for perl v5.21.1
9
10=head1 DESCRIPTION
11
12This document describes differences between the 5.21.0 release and the 5.21.1
13release.
14
15If you are upgrading from an earlier release such as 5.20.0, first read
16L<perl5210delta>, which describes differences between 5.20.0 and 5.21.0.
17
18=head1 Notice
19
20XXX Any important notices here
21
22=head1 Core Enhancements
23
24XXX New core language features go here. Summarize user-visible core language
25enhancements. Particularly prominent performance optimisations could go
26here, but most should go in the L</Performance Enhancements> section.
27
28[ List each enhancement as a =head2 entry ]
29
30=head1 Security
31
32XXX Any security-related notices go here. In particular, any security
33vulnerabilities closed should be noted here rather than in the
34L</Selected Bug Fixes> section.
35
36[ List each security issue as a =head2 entry ]
37
38=head1 Incompatible Changes
39
40XXX 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
50XXX Any deprecated features, syntax, modules etc. should be listed here.
51
52=head2 Module removals
53
54XXX Remove this section if inapplicable.
55
56The following modules will be removed from the core distribution in a
57future release, and will at that time need to be installed from CPAN.
58Distributions on CPAN which require these modules will need to list them as
59prerequisites.
60
61The core versions of these modules will now issue C<"deprecated">-category
62warnings to alert you to this fact. To silence these deprecation warnings,
63install the modules in question from CPAN.
64
65Note that these are (with rare exceptions) fine modules that you are encouraged
66to continue to use. Their disinclusion from core primarily hinges on their
67necessity to bootstrapping a fully functional, CPAN-capable Perl installation,
68not usually on concerns over their design.
69
70=over
71
72=item XXX
73
74XXX Note that deprecated modules should be listed here even if they are listed
75as 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
83XXX Changes which enhance performance without changing behaviour go here.
84There 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
92XXX
93
94=back
95
96=head1 Modules and Pragmata
97
98XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
99go here. If Module::CoreList is updated, generate an initial draft of the
100following sections using F<Porting/corelist-perldelta.pl>. A paragraph summary
101for important changes should then be added by hand. In an ideal world,
102dual-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
112XXX
113
114=back
115
116=head2 Updated Modules and Pragmata
117
118=over 4
119
120=item *
121
122L<perl5db.pl> has been upgraded from version 1.44 to 1.45.
123
124fork() in the debugger under C<tmux> will now create a new window for
125the forked process. L<[perl
126#121333]|https://rt.perl.org/Ticket/Display.html?id=121333>
127
128The debugger now saves the current working directory on startup and
129restores it when you restart your program with C<R> or <rerun>. L<[perl
130#121509]|https://rt.perl.org/Ticket/Display.html?id=121509>
131
132=back
133
134=head2 Removed Modules and Pragmata
135
136=over 4
137
138=item *
139
140XXX
141
142=back
143
144=head1 Documentation
145
146XXX Changes to files in F<pod/> go here. Consider grouping entries by
147file and be sure to link to the appropriate page, e.g. L<perlfunc>.
148
149=head2 New Documentation
150
151XXX Changes which create B<new> files in F<pod/> go here.
152
153=head3 L<XXX>
154
155XXX Description of the purpose of the new file here
156
157=head2 Changes to Existing Documentation
158
159XXX Changes which significantly change existing files in F<pod/> go here.
160However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
161section.
162
163=head3 L<XXX>
164
165=over 4
166
167=item *
168
169XXX Description of the change here
170
171=back
172
173=head1 Diagnostics
174
175The following additions or changes have been made to diagnostic output,
176including warnings and fatal error messages. For the complete list of
177diagnostic messages, see L<perldiag>.
178
179XXX New or changed warnings emitted by the core's C<C> code go here. Also
180include any changes in L<perldiag> that reconcile it to the C<C> code.
181
182=head2 New Diagnostics
183
184XXX Newly added diagnostic messages go under here, separated into New Errors
185and New Warnings
186
187=head3 New Errors
188
189=over 4
190
191=item *
192
193XXX L<message|perldiag/"message">
194
195=back
196
197=head3 New Warnings
198
199=over 4
200
201=item *
202
203XXX L<message|perldiag/"message">
204
205=back
206
207=head2 Changes to Existing Diagnostics
208
209XXX Changes (i.e. rewording) of diagnostic messages go here
210
211=over 4
212
213=item *
214
215L<Unsuccessful %s on filename containing newline|perldiag/"Unsuccessful %s on filename containing newline">
216
217This warning is now only produced when the newline is at the end of
218the filename.
219
220=back
221
222=head1 Utility Changes
223
224XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here.
225Most of these are built within the directories F<utils> and F<x2p>.
226
227[ List utility changes as a =head2 entry for each utility and =item
228entries for each change
229Use L<XXX> with program names to get proper documentation linking. ]
230
231=head2 L<XXX>
232
233=over 4
234
235=item *
236
237XXX
238
239=back
240
241=head1 Configuration and Compilation
242
243XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
244go here. Any other changes to the Perl build process should be listed here.
245However, any platform-specific changes should be listed in the
246L</Platform Support> section, instead.
247
248[ List changes as a =item entry ].
249
250=over 4
251
252=item *
253
254XXX
255
256=back
257
258=head1 Testing
259
260XXX Any significant changes to the testing of a freshly built perl should be
261listed here. Changes which create B<new> files in F<t/> go here as do any
262large changes to the testing harness (e.g. when parallel testing was added).
263Changes to existing files in F<t/> aren't worth summarizing, although the bugs
264that they represent may be covered elsewhere.
265
266[ List each test improvement as a =item entry ]
267
268=over 4
269
270=item *
271
272XXX
273
274=back
275
276=head1 Platform Support
277
278XXX 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
281changes as paragraphs below it. ]
282
283=head2 New Platforms
284
285XXX List any platforms that this version of perl compiles on, that previous
286versions did not. These will either be enabled by new files in the F<hints/>
287directories, or new subdirectories and F<README> files at the top level of the
288source tree.
289
290=over 4
291
292=item XXX-some-platform
293
294XXX
295
296=back
297
298=head2 Discontinued Platforms
299
300XXX List any platforms that this version of perl no longer compiles on.
301
302=over 4
303
304=item XXX-some-platform
305
306XXX
307
308=back
309
310=head2 Platform-Specific Notes
311
312XXX List any changes for specific platforms. This could include configuration
313and compilation changes or changes in portability/compatibility. However,
314changes within modules for platforms should generally be listed in the
315L</Modules and Pragmata> section.
316
317=over 4
318
319=item XXX-some-platform
320
321XXX
322
323=back
324
325=head1 Internal Changes
326
327XXX Changes which affect the interface available to C<XS> code go here. Other
328significant internal changes for future core maintainers should be noted as
329well.
330
331[ List each change as a =item entry ]
332
333=over 4
334
335=item *
336
337XXX
338
339=back
340
341=head1 Selected Bug Fixes
342
343XXX Important bug fixes in the core language are summarized here. Bug fixes in
344files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>.
345
346[ List each fix as a =item entry ]
347
348=over 4
349
350=item *
351
352index() and rindex() no longer crash when used on strings over 2GB in
353size.
354L<[perl #121562]|https://rt.perl.org/Ticket/Display.html?id=121562>.
355
356=back
357
358=head1 Known Problems
359
360XXX Descriptions of platform agnostic bugs we know we can't fix go here. Any
361tests that had to be C<TODO>ed for the release would be noted here. Unfixed
362platform specific bugs also go here.
363
364[ List each fix as a =item entry ]
365
366=over 4
367
368=item *
369
370XXX
371
372=back
373
374=head1 Errata From Previous Releases
375
376=over 4
377
378=item *
379
380XXX Add anything here that we forgot to add, or were mistaken about, in
381the perldelta of a previous release.
382
383=back
384
385=head1 Obituary
386
387XXX If any significant core contributor has died, we've added a short obituary
388here.
389
390=head1 Acknowledgements
391
392XXX Generate this with:
393
394 perl Porting/acknowledgements.pl v5.21.1..HEAD
395
396=head1 Reporting Bugs
397
398If you find what you think is a bug, you might check the articles recently
399posted to the comp.lang.perl.misc newsgroup and the perl bug database at
400https://rt.perl.org/ . There may also be information at
401http://www.perl.org/ , the Perl Home Page.
402
403If you believe you have an unreported bug, please run the L<perlbug> program
404included with your release. Be sure to trim your bug down to a tiny but
405sufficient test case. Your bug report, along with the output of C<perl -V>,
406will be sent off to perlbug@perl.org to be analysed by the Perl porting team.
407
408If the bug you are reporting has security implications, which make it
409inappropriate to send to a publicly archived mailing list, then please send it
410to perl5-security-report@perl.org. This points to a closed subscription
411unarchived mailing list, which includes all the core committers, who will be
412able to help assess the impact of issues, figure out a resolution, and help
413co-ordinate the release of patches to mitigate or fix the problem across all
414platforms on which Perl is supported. Please only use this address for
415security issues in the Perl core, not for modules independently distributed on
416CPAN.
417
418=head1 SEE ALSO
419
420The F<Changes> file for an explanation of how to view exhaustive details on
421what changed.
422
423The F<INSTALL> file for how to build Perl.
424
425The F<README> file for general stuff.
426
427The F<Artistic> and F<Copying> files for copyright information.
428
429=cut