This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
perldelta for 486b1e7f0
[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.19.3
9
10 =head1 DESCRIPTION
11
12 This document describes differences between the 5.19.2 release and the 5.19.3
13 release.
14
15 If you are upgrading from an earlier release such as 5.19.1, first read
16 L<perl5192delta>, which describes differences between 5.19.1 and 5.19.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 =head2 B<-F> now implies B<-a> and B<-a> implies B<-n>
31
32 Previously B<-F> without B<-a> was a no-op, and B<-a> without B<-n> or
33 B<-p> was a no-op, with this change, if you supply B<-F> then both
34 B<-a> and B<-n> are implied and if you supply B<-a> then B<-n> is implied.
35
36 You can still use B<-p> for its extra behaviour. [perl #116190]
37
38 =head1 Security
39
40 XXX Any security-related notices go here.  In particular, any security
41 vulnerabilities closed should be noted here rather than in the
42 L</Selected Bug Fixes> section.
43
44 [ List each security issue as a =head2 entry ]
45
46 =head1 Incompatible Changes
47
48 XXX For a release on a stable branch, this section aspires to be:
49
50     There are no changes intentionally incompatible with 5.XXX.XXX
51     If any exist, they are bugs, and we request that you submit a
52     report.  See L</Reporting Bugs> below.
53
54 [ List each incompatible change as a =head2 entry ]
55
56 =head1 Deprecations
57
58 XXX Any deprecated features, syntax, modules etc. should be listed here.
59
60 =head2 Module removals
61
62 XXX Remove this section if inapplicable.
63
64 The following modules will be removed from the core distribution in a
65 future release, and will at that time need to be installed from CPAN.
66 Distributions on CPAN which require these modules will need to list them as
67 prerequisites.
68
69 The core versions of these modules will now issue C<"deprecated">-category
70 warnings to alert you to this fact.  To silence these deprecation warnings,
71 install the modules in question from CPAN.
72
73 Note that these are (with rare exceptions) fine modules that you are encouraged
74 to continue to use.  Their disinclusion from core primarily hinges on their
75 necessity to bootstrapping a fully functional, CPAN-capable Perl installation,
76 not usually on concerns over their design.
77
78 =over
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>, which prints stub
107 entries to STDOUT.  Results can be pasted in place of the '=head2' entries
108 below.  A paragraph summary for important changes should then be added by hand.
109 In an ideal world, dual-life modules would have a F<Changes> file that could be
110 cribbed.
111
112 [ Within each section, list entries as a =item entry ]
113
114 =head2 New Modules and Pragmata
115
116 =over 4
117
118 =item *
119
120 XXX
121
122 =back
123
124 =head2 Updated Modules and Pragmata
125
126 =over 4
127
128 =item *
129
130 L<B> has been upgraded from version 1.44 to 1.45.
131
132 Calling the C<GV> method on C<B::CV> objects created from a lexical
133 sub would return nonsense, possibly crashing perl. C<GV> now returns
134 C<undef> for lexical subs. [perl #118525]
135
136 Added the C<NAME_HEK> method to return the name of a lexical sub.
137
138 =item *
139
140 L<Data::Dumper> has been upgraded from version 2.147 to 2.148.
141
142 The compatbility of the XS implementation with the pure perl version
143 under C<Useqq> has been improved. [perl #118933]
144
145 =item *
146
147 L<Storable> has been upgraded from version 2.45 to 2.46.
148
149 Avoid creating temporary objects for STORABLE_attach when they aren't
150 required. [perl #118907]
151
152 =item *
153
154 L<bignum> has been upgraded from version 0.35 to 0.36.
155
156 L<bigrat> wasn't correctly updating an internal variable when C<use>d
157 with a C<lib> option.
158
159 =item *
160
161 L<Exporter> has been upgraded from version 5.68 to 5.69.
162
163 L<Exporter> would ignore custom C<$SIG{__WARN__}> handlers in
164 C<Exporter::Heavy>. [perl #39739]
165
166 =back
167
168 =head2 Removed Modules and Pragmata
169
170 =over 4
171
172 =item *
173
174 XXX
175
176 =back
177
178 =head1 Documentation
179
180 XXX Changes to files in F<pod/> go here.  Consider grouping entries by
181 file and be sure to link to the appropriate page, e.g. L<perlfunc>.
182
183 =head2 New Documentation
184
185 XXX Changes which create B<new> files in F<pod/> go here.
186
187 =head3 L<XXX>
188
189 XXX Description of the purpose of the new file here
190
191 =head2 Changes to Existing Documentation
192
193 XXX Changes which significantly change existing files in F<pod/> go here.
194 However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
195 section.
196
197 =head3 L<perlopentut>
198
199 =over 4
200
201 =item *
202
203 The C<open> tutorial has been completely rewriten by Tom Christiansen, and now
204 focuses on covering only the basics, rather than providing a comprehensive
205 reference to all things openable.  This rewrite came as the result of a
206 vigorous discussion on perl5-porters kicked off by a set of improvements
207 written by Alexander Hartmaier to the existing C<perlopentut>.  A "more than
208 you ever wanted to know about C<open>" document may follow in subsequent
209 versions of perl.
210
211 =back
212
213 =head1 Diagnostics
214
215 The following additions or changes have been made to diagnostic output,
216 including warnings and fatal error messages.  For the complete list of
217 diagnostic messages, see L<perldiag>.
218
219 XXX New or changed warnings emitted by the core's C<C> code go here.  Also
220 include any changes in L<perldiag> that reconcile it to the C<C> code.
221
222 =head2 New Diagnostics
223
224 XXX Newly added diagnostic messages go under here, separated into New Errors
225 and New Warnings
226
227 =head3 New Errors
228
229 =over 4
230
231 =item *
232
233 XXX L<message|perldiag/"message">
234
235 =back
236
237 =head3 New Warnings
238
239 =over 4
240
241 =item *
242
243 XXX L<message|perldiag/"message">
244
245 =back
246
247 =head2 Changes to Existing Diagnostics
248
249 XXX Changes (i.e. rewording) of diagnostic messages go here
250
251 =over 4
252
253 =item *
254
255 XXX Describe change here
256
257 =back
258
259 =head1 Utility Changes
260
261 XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here.
262 Most of these are built within the directories F<utils> and F<x2p>.
263
264 [ List utility changes as a =head3 entry for each utility and =item
265 entries for each change
266 Use L<XXX> with program names to get proper documentation linking. ]
267
268 =head3 L<XXX>
269
270 =over 4
271
272 =item *
273
274 XXX
275
276 =back
277
278 =head1 Configuration and Compilation
279
280 XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
281 go here.  Any other changes to the Perl build process should be listed here.
282 However, any platform-specific changes should be listed in the
283 L</Platform Support> section, instead.
284
285 [ List changes as a =item entry ].
286
287 =over 4
288
289 =item *
290
291 XXX
292
293 =back
294
295 =head1 Testing
296
297 XXX Any significant changes to the testing of a freshly built perl should be
298 listed here.  Changes which create B<new> files in F<t/> go here as do any
299 large changes to the testing harness (e.g. when parallel testing was added).
300 Changes to existing files in F<t/> aren't worth summarizing, although the bugs
301 that they represent may be covered elsewhere.
302
303 [ List each test improvement as a =item entry ]
304
305 =over 4
306
307 =item *
308
309 XXX
310
311 =back
312
313 =head1 Platform Support
314
315 XXX Any changes to platform support should be listed in the sections below.
316
317 [ Within the sections, list each platform as a =item entry with specific
318 changes as paragraphs below it. ]
319
320 =head2 New Platforms
321
322 XXX List any platforms that this version of perl compiles on, that previous
323 versions did not.  These will either be enabled by new files in the F<hints/>
324 directories, or new subdirectories and F<README> files at the top level of the
325 source tree.
326
327 =over 4
328
329 =item XXX-some-platform
330
331 XXX
332
333 =back
334
335 =head2 Discontinued Platforms
336
337 XXX List any platforms that this version of perl no longer compiles on.
338
339 =over 4
340
341 =item XXX-some-platform
342
343 XXX
344
345 =back
346
347 =head2 Platform-Specific Notes
348
349 XXX List any changes for specific platforms.  This could include configuration
350 and compilation changes or changes in portability/compatibility.  However,
351 changes within modules for platforms should generally be listed in the
352 L</Modules and Pragmata> section.
353
354 =over 4
355
356 =item XXX-some-platform
357
358 XXX
359
360 =back
361
362 =head1 Internal Changes
363
364 XXX Changes which affect the interface available to C<XS> code go here.  Other
365 significant internal changes for future core maintainers should be noted as
366 well.
367
368 [ List each change as a =item entry ]
369
370 =over 4
371
372 =item *
373
374 XXX
375
376 =back
377
378 =head1 Selected Bug Fixes
379
380 XXX Important bug fixes in the core language are summarized here.  Bug fixes in
381 files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>.
382
383 [ List each fix as a =item entry ]
384
385 =over 4
386
387 =item *
388
389 Autovivifying a subroutine stub via C<\&$glob> started causing crashes in
390 Perl 5.18.0 if the $glob was merely a copy of a real glob, i.e., a scalar
391 that had had a glob assigned to it.  This has been fixed [perl #119051].
392
393 =back
394
395 =head1 Known Problems
396
397 XXX Descriptions of platform agnostic bugs we know we can't fix go here.  Any
398 tests that had to be C<TODO>ed for the release would be noted here.  Unfixed
399 platform specific bugs also go here.
400
401 [ List each fix as a =item entry ]
402
403 =over 4
404
405 =item *
406
407 XXX
408
409 =back
410
411 =head1 Obituary
412
413 XXX If any significant core contributor has died, we've added a short obituary
414 here.
415
416 =head1 Acknowledgements
417
418 XXX Generate this with:
419
420   perl Porting/acknowledgements.pl v5.19.2..HEAD
421
422 =head1 Reporting Bugs
423
424 If you find what you think is a bug, you might check the articles recently
425 posted to the comp.lang.perl.misc newsgroup and the perl bug database at
426 http://rt.perl.org/perlbug/ .  There may also be information at
427 http://www.perl.org/ , the Perl Home Page.
428
429 If you believe you have an unreported bug, please run the L<perlbug> program
430 included with your release.  Be sure to trim your bug down to a tiny but
431 sufficient test case.  Your bug report, along with the output of C<perl -V>,
432 will be sent off to perlbug@perl.org to be analysed by the Perl porting team.
433
434 If the bug you are reporting has security implications, which make it
435 inappropriate to send to a publicly archived mailing list, then please send it
436 to perl5-security-report@perl.org.  This points to a closed subscription
437 unarchived mailing list, which includes all the core committers, who will be
438 able to help assess the impact of issues, figure out a resolution, and help
439 co-ordinate the release of patches to mitigate or fix the problem across all
440 platforms on which Perl is supported.  Please only use this address for
441 security issues in the Perl core, not for modules independently distributed on
442 CPAN.
443
444 =head1 SEE ALSO
445
446 The F<Changes> file for an explanation of how to view exhaustive details on
447 what changed.
448
449 The F<INSTALL> file for how to build Perl.
450
451 The F<README> file for general stuff.
452
453 The F<Artistic> and F<Copying> files for copyright information.
454
455 =cut