This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
perldelta for 3699825258c
[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.21.3
9
10 =head1 DESCRIPTION
11
12 This document describes differences between the 5.21.2 release and the 5.21.3
13 release.
14
15 If you are upgrading from an earlier release such as 5.21.1, first read
16 L<perl5212delta>, which describes differences between 5.21.1 and 5.21.2.
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 =head2 S<C<use UNIVERSAL '...'>> is now a fatal error
49
50 Importing functions from C<UNIVERSAL> has been deprecated since v5.12, and
51 is now a fatal error.  S<C<"use UNIVERSAL">> without any arguments is still
52 allowed.
53
54 =head1 Deprecations
55
56 XXX Any deprecated features, syntax, modules etc. should be listed here.
57
58 =head2 Module removals
59
60 XXX Remove this section if inapplicable.
61
62 The following modules will be removed from the core distribution in a
63 future release, and will at that time need to be installed from CPAN.
64 Distributions on CPAN which require these modules will need to list them as
65 prerequisites.
66
67 The core versions of these modules will now issue C<"deprecated">-category
68 warnings to alert you to this fact.  To silence these deprecation warnings,
69 install the modules in question from CPAN.
70
71 Note that these are (with rare exceptions) fine modules that you are encouraged
72 to continue to use.  Their disinclusion from core primarily hinges on their
73 necessity to bootstrapping a fully functional, CPAN-capable Perl installation,
74 not usually on concerns over their design.
75
76 =over
77
78 =item XXX
79
80 XXX Note that deprecated modules should be listed here even if they are listed
81 as an updated module in the L</Modules and Pragmata> section.
82
83 =back
84
85 [ List each other deprecation as a =head2 entry ]
86
87 =head1 Performance Enhancements
88
89 XXX Changes which enhance performance without changing behaviour go here.
90 There may well be none in a stable release.
91
92 [ List each enhancement as a =item entry ]
93
94 =over 4
95
96 =item *
97
98 XXX
99
100 =back
101
102 =head1 Modules and Pragmata
103
104 XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
105 go here.  If Module::CoreList is updated, generate an initial draft of the
106 following sections using F<Porting/corelist-perldelta.pl>.  A paragraph summary
107 for important changes should then be added by hand.  In an ideal world,
108 dual-life modules would have a F<Changes> file that could be cribbed.
109
110 [ Within each section, list entries as a =item entry ]
111
112 =head2 New Modules and Pragmata
113
114 =over 4
115
116 =item *
117
118 XXX
119
120 =back
121
122 =head2 Updated Modules and Pragmata
123
124 =over 4
125
126 =item *
127
128 L<perl5db.pl> has been upgraded from version 1.45 to 1.46.
129
130 Fixed the scope level handling of the debugger's C<y> command.
131
132 =item *
133
134 L<POSIX> has been upgraded from version 1.41 to 1.42.
135
136 Replaced the thread-unsafe code used to prevent duplicate warning
137 messages for using the isxxx() functions.  [perl #122476]
138
139 =item *
140
141 L<Socket> has been upgraded from version 2.014 to 2.015.
142
143 Test suite updates, particularly useful for Solaris and cygwin, and
144 a slight change to the pattern used for IPv4 address matching.
145
146 =back
147
148 =head2 Removed Modules and Pragmata
149
150 =over 4
151
152 =item *
153
154 XXX
155
156 =back
157
158 =head1 Documentation
159
160 XXX Changes to files in F<pod/> go here.  Consider grouping entries by
161 file and be sure to link to the appropriate page, e.g. L<perlfunc>.
162
163 =head2 New Documentation
164
165 XXX Changes which create B<new> files in F<pod/> go here.
166
167 =head3 L<XXX>
168
169 XXX Description of the purpose of the new file here
170
171 =head2 Changes to Existing Documentation
172
173 XXX Changes which significantly change existing files in F<pod/> go here.
174 However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
175 section.
176
177 =head3 L<XXX>
178
179 =over 4
180
181 =item *
182
183 XXX Description of the change here
184
185 =back
186
187 =head1 Diagnostics
188
189 The following additions or changes have been made to diagnostic output,
190 including warnings and fatal error messages.  For the complete list of
191 diagnostic messages, see L<perldiag>.
192
193 XXX New or changed warnings emitted by the core's C<C> code go here.  Also
194 include any changes in L<perldiag> that reconcile it to the C<C> code.
195
196 =head2 New Diagnostics
197
198 XXX Newly added diagnostic messages go under here, separated into New Errors
199 and New Warnings
200
201 =head3 New Errors
202
203 =over 4
204
205 =item *
206
207 XXX L<message|perldiag/"message">
208
209 =back
210
211 =head3 New Warnings
212
213 =over 4
214
215 =item *
216
217 XXX L<message|perldiag/"message">
218
219 =back
220
221 =head2 Changes to Existing Diagnostics
222
223 XXX Changes (i.e. rewording) of diagnostic messages go here
224
225 =over 4
226
227 =item *
228
229 XXX Describe change here
230
231 =back
232
233 =head1 Utility Changes
234
235 XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here.
236 Most of these are built within the directory F<utils>.
237
238 [ List utility changes as a =head2 entry for each utility and =item
239 entries for each change
240 Use L<XXX> with program names to get proper documentation linking. ]
241
242 =head2 L<XXX>
243
244 =over 4
245
246 =item *
247
248 XXX
249
250 =back
251
252 =head1 Configuration and Compilation
253
254 XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
255 go here.  Any other changes to the Perl build process should be listed here.
256 However, any platform-specific changes should be listed in the
257 L</Platform Support> section, instead.
258
259 [ List changes as a =item entry ].
260
261 =over 4
262
263 =item *
264
265 XXX
266
267 =back
268
269 =head1 Testing
270
271 XXX Any significant changes to the testing of a freshly built perl should be
272 listed here.  Changes which create B<new> files in F<t/> go here as do any
273 large changes to the testing harness (e.g. when parallel testing was added).
274 Changes to existing files in F<t/> aren't worth summarizing, although the bugs
275 that they represent may be covered elsewhere.
276
277 [ List each test improvement as a =item entry ]
278
279 =over 4
280
281 =item *
282
283 XXX
284
285 =back
286
287 =head1 Platform Support
288
289 XXX Any changes to platform support should be listed in the sections below.
290
291 [ Within the sections, list each platform as a =item entry with specific
292 changes as paragraphs below it. ]
293
294 =head2 New Platforms
295
296 XXX List any platforms that this version of perl compiles on, that previous
297 versions did not.  These will either be enabled by new files in the F<hints/>
298 directories, or new subdirectories and F<README> files at the top level of the
299 source tree.
300
301 =over 4
302
303 =item XXX-some-platform
304
305 XXX
306
307 =back
308
309 =head2 Discontinued Platforms
310
311 XXX List any platforms that this version of perl no longer compiles on.
312
313 =over 4
314
315 =item XXX-some-platform
316
317 XXX
318
319 =back
320
321 =head2 Platform-Specific Notes
322
323 XXX List any changes for specific platforms.  This could include configuration
324 and compilation changes or changes in portability/compatibility.  However,
325 changes within modules for platforms should generally be listed in the
326 L</Modules and Pragmata> section.
327
328 =over 4
329
330 =item XXX-some-platform
331
332 XXX
333
334 =back
335
336 =head1 Internal Changes
337
338 XXX Changes which affect the interface available to C<XS> code go here.  Other
339 significant internal changes for future core maintainers should be noted as
340 well.
341
342 [ List each change as a =item entry ]
343
344 =over 4
345
346 =item *
347
348 Added L<perlapi/sync_locale>.
349 Changing the program's locale should be avoided by XS code.  Nevertheless,
350 certain non-Perl libraries called from XS, such as C<Gtk> do so.  When this
351 happens, Perl needs to be told that the locale has changed.  Use this function
352 to do so, before returning to Perl.
353
354 =back
355
356 =head1 Selected Bug Fixes
357
358 XXX Important bug fixes in the core language are summarized here.  Bug fixes in
359 files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>.
360
361 [ List each fix as a =item entry ]
362
363 =over 4
364
365 =item *
366
367 Failing to compile C<use Foo> in an eval could leave a spurious
368 C<BEGIN> subroutine definition, which would produce a "Subroutine
369 BEGIN redefined" warning on the next use of C<use>, or other C<BEGIN>
370 block.  [perl #122107]
371
372 =item *
373
374 C<method { BLOCK } ARGS> syntax now correctly parses the arguments if they
375 begin with an opening brace.  [perl #46947]
376
377 =back
378
379 =head1 Known Problems
380
381 XXX Descriptions of platform agnostic bugs we know we can't fix go here.  Any
382 tests that had to be C<TODO>ed for the release would be noted here.  Unfixed
383 platform specific bugs also go here.
384
385 [ List each fix as a =item entry ]
386
387 =over 4
388
389 =item *
390
391 XXX
392
393 =back
394
395 =head1 Errata From Previous Releases
396
397 =over 4
398
399 =item *
400
401 XXX Add anything here that we forgot to add, or were mistaken about, in
402 the perldelta of a previous release.
403
404 =back
405
406 =head1 Obituary
407
408 XXX If any significant core contributor has died, we've added a short obituary
409 here.
410
411 =head1 Acknowledgements
412
413 XXX Generate this with:
414
415   perl Porting/acknowledgements.pl v5.21.2..HEAD
416
417 =head1 Reporting Bugs
418
419 If you find what you think is a bug, you might check the articles recently
420 posted to the comp.lang.perl.misc newsgroup and the perl bug database at
421 https://rt.perl.org/ .  There may also be information at
422 http://www.perl.org/ , the Perl Home Page.
423
424 If you believe you have an unreported bug, please run the L<perlbug> program
425 included with your release.  Be sure to trim your bug down to a tiny but
426 sufficient test case.  Your bug report, along with the output of C<perl -V>,
427 will be sent off to perlbug@perl.org to be analysed by the Perl porting team.
428
429 If the bug you are reporting has security implications, which make it
430 inappropriate to send to a publicly archived mailing list, then please send it
431 to perl5-security-report@perl.org.  This points to a closed subscription
432 unarchived mailing list, which includes all the core committers, who will be
433 able to help assess the impact of issues, figure out a resolution, and help
434 co-ordinate the release of patches to mitigate or fix the problem across all
435 platforms on which Perl is supported.  Please only use this address for
436 security issues in the Perl core, not for modules independently distributed on
437 CPAN.
438
439 =head1 SEE ALSO
440
441 The F<Changes> file for an explanation of how to view exhaustive details on
442 what changed.
443
444 The F<INSTALL> file for how to build Perl.
445
446 The F<README> file for general stuff.
447
448 The F<Artistic> and F<Copying> files for copyright information.
449
450 =cut