This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
perldelta typo fix: change a ',' to a '.'
[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 =back
140
141 =head2 Removed Modules and Pragmata
142
143 =over 4
144
145 =item *
146
147 XXX
148
149 =back
150
151 =head1 Documentation
152
153 XXX Changes to files in F<pod/> go here.  Consider grouping entries by
154 file and be sure to link to the appropriate page, e.g. L<perlfunc>.
155
156 =head2 New Documentation
157
158 XXX Changes which create B<new> files in F<pod/> go here.
159
160 =head3 L<XXX>
161
162 XXX Description of the purpose of the new file here
163
164 =head2 Changes to Existing Documentation
165
166 XXX Changes which significantly change existing files in F<pod/> go here.
167 However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
168 section.
169
170 =head3 L<XXX>
171
172 =over 4
173
174 =item *
175
176 XXX Description of the change here
177
178 =back
179
180 =head1 Diagnostics
181
182 The following additions or changes have been made to diagnostic output,
183 including warnings and fatal error messages.  For the complete list of
184 diagnostic messages, see L<perldiag>.
185
186 XXX New or changed warnings emitted by the core's C<C> code go here.  Also
187 include any changes in L<perldiag> that reconcile it to the C<C> code.
188
189 =head2 New Diagnostics
190
191 XXX Newly added diagnostic messages go under here, separated into New Errors
192 and New Warnings
193
194 =head3 New Errors
195
196 =over 4
197
198 =item *
199
200 XXX L<message|perldiag/"message">
201
202 =back
203
204 =head3 New Warnings
205
206 =over 4
207
208 =item *
209
210 XXX L<message|perldiag/"message">
211
212 =back
213
214 =head2 Changes to Existing Diagnostics
215
216 XXX Changes (i.e. rewording) of diagnostic messages go here
217
218 =over 4
219
220 =item *
221
222 XXX Describe change here
223
224 =back
225
226 =head1 Utility Changes
227
228 XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here.
229 Most of these are built within the directory F<utils>.
230
231 [ List utility changes as a =head2 entry for each utility and =item
232 entries for each change
233 Use L<XXX> with program names to get proper documentation linking. ]
234
235 =head2 L<XXX>
236
237 =over 4
238
239 =item *
240
241 XXX
242
243 =back
244
245 =head1 Configuration and Compilation
246
247 XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
248 go here.  Any other changes to the Perl build process should be listed here.
249 However, any platform-specific changes should be listed in the
250 L</Platform Support> section, instead.
251
252 [ List changes as a =item entry ].
253
254 =over 4
255
256 =item *
257
258 XXX
259
260 =back
261
262 =head1 Testing
263
264 XXX Any significant changes to the testing of a freshly built perl should be
265 listed here.  Changes which create B<new> files in F<t/> go here as do any
266 large changes to the testing harness (e.g. when parallel testing was added).
267 Changes to existing files in F<t/> aren't worth summarizing, although the bugs
268 that they represent may be covered elsewhere.
269
270 [ List each test improvement as a =item entry ]
271
272 =over 4
273
274 =item *
275
276 XXX
277
278 =back
279
280 =head1 Platform Support
281
282 XXX Any changes to platform support should be listed in the sections below.
283
284 [ Within the sections, list each platform as a =item entry with specific
285 changes as paragraphs below it. ]
286
287 =head2 New Platforms
288
289 XXX List any platforms that this version of perl compiles on, that previous
290 versions did not.  These will either be enabled by new files in the F<hints/>
291 directories, or new subdirectories and F<README> files at the top level of the
292 source tree.
293
294 =over 4
295
296 =item XXX-some-platform
297
298 XXX
299
300 =back
301
302 =head2 Discontinued Platforms
303
304 XXX List any platforms that this version of perl no longer compiles on.
305
306 =over 4
307
308 =item XXX-some-platform
309
310 XXX
311
312 =back
313
314 =head2 Platform-Specific Notes
315
316 XXX List any changes for specific platforms.  This could include configuration
317 and compilation changes or changes in portability/compatibility.  However,
318 changes within modules for platforms should generally be listed in the
319 L</Modules and Pragmata> section.
320
321 =over 4
322
323 =item XXX-some-platform
324
325 XXX
326
327 =back
328
329 =head1 Internal Changes
330
331 XXX Changes which affect the interface available to C<XS> code go here.  Other
332 significant internal changes for future core maintainers should be noted as
333 well.
334
335 [ List each change as a =item entry ]
336
337 =over 4
338
339 =item *
340
341 Added L<perlapi/sync_locale>.
342 Changing the program's locale should be avoided by XS code.  Nevertheless,
343 certain non-Perl libraries called from XS, such as C<Gtk> do so.  When this
344 happens, Perl needs to be told that the locale has changed.  Use this function
345 to do so, before returning to Perl.
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 Failing to compile C<use Foo> in an eval could leave a spurious
361 C<BEGIN> subroutine definition, which would produce a "Subroutine
362 BEGIN redefined" warning on the next use of C<use>, or other C<BEGIN>
363 block.  [perl #122107]
364
365 =item *
366
367 C<method { BLOCK } ARGS> syntax now correctly parses the arguments if they
368 begin with an opening brace.  [perl #46947]
369
370 =back
371
372 =head1 Known Problems
373
374 XXX Descriptions of platform agnostic bugs we know we can't fix go here.  Any
375 tests that had to be C<TODO>ed for the release would be noted here.  Unfixed
376 platform specific bugs also go here.
377
378 [ List each fix as a =item entry ]
379
380 =over 4
381
382 =item *
383
384 XXX
385
386 =back
387
388 =head1 Errata From Previous Releases
389
390 =over 4
391
392 =item *
393
394 XXX Add anything here that we forgot to add, or were mistaken about, in
395 the perldelta of a previous release.
396
397 =back
398
399 =head1 Obituary
400
401 XXX If any significant core contributor has died, we've added a short obituary
402 here.
403
404 =head1 Acknowledgements
405
406 XXX Generate this with:
407
408   perl Porting/acknowledgements.pl v5.21.2..HEAD
409
410 =head1 Reporting Bugs
411
412 If you find what you think is a bug, you might check the articles recently
413 posted to the comp.lang.perl.misc newsgroup and the perl bug database at
414 https://rt.perl.org/ .  There may also be information at
415 http://www.perl.org/ , the Perl Home Page.
416
417 If you believe you have an unreported bug, please run the L<perlbug> program
418 included with your release.  Be sure to trim your bug down to a tiny but
419 sufficient test case.  Your bug report, along with the output of C<perl -V>,
420 will be sent off to perlbug@perl.org to be analysed by the Perl porting team.
421
422 If the bug you are reporting has security implications, which make it
423 inappropriate to send to a publicly archived mailing list, then please send it
424 to perl5-security-report@perl.org.  This points to a closed subscription
425 unarchived mailing list, which includes all the core committers, who will be
426 able to help assess the impact of issues, figure out a resolution, and help
427 co-ordinate the release of patches to mitigate or fix the problem across all
428 platforms on which Perl is supported.  Please only use this address for
429 security issues in the Perl core, not for modules independently distributed on
430 CPAN.
431
432 =head1 SEE ALSO
433
434 The F<Changes> file for an explanation of how to view exhaustive details on
435 what changed.
436
437 The F<INSTALL> file for how to build Perl.
438
439 The F<README> file for general stuff.
440
441 The F<Artistic> and F<Copying> files for copyright information.
442
443 =cut