This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
5dc1187dd3bfe215541693af68a9b7fd35454ee5
[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<Data::Dumper> has been upgraded from version 2.147 to 2.148.
131
132 The compatbility of the XS implementation with the pure perl version
133 under C<Useqq> has been improved. [perl #118933]
134
135 =item *
136
137 L<Storable> has been upgraded from version 2.45 to 2.46.
138
139 Avoid creating temporary objects for STORABLE_attach when they aren't
140 required. [perl #118907]
141
142 =item *
143
144 L<bignum> has been upgraded from version 0.35 to 0.36.
145
146 L<bigrat> wasn't correctly updating an internal variable when C<use>d
147 with a C<lib> option.
148
149 =item *
150
151 L<Exporter> has been upgraded from version 5.68 to 5.69.
152
153 L<Exporter> would ignore custom C<$SIG{__WARN__}> handlers in
154 C<Exporter::Heavy>. [perl #39739]
155
156 =back
157
158 =head2 Removed Modules and Pragmata
159
160 =over 4
161
162 =item *
163
164 XXX
165
166 =back
167
168 =head1 Documentation
169
170 XXX Changes to files in F<pod/> go here.  Consider grouping entries by
171 file and be sure to link to the appropriate page, e.g. L<perlfunc>.
172
173 =head2 New Documentation
174
175 XXX Changes which create B<new> files in F<pod/> go here.
176
177 =head3 L<XXX>
178
179 XXX Description of the purpose of the new file here
180
181 =head2 Changes to Existing Documentation
182
183 XXX Changes which significantly change existing files in F<pod/> go here.
184 However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
185 section.
186
187 =head3 L<perlopentut>
188
189 =over 4
190
191 =item *
192
193 The C<open> tutorial has been completely rewriten by Tom Christiansen, and now
194 focuses on covering only the basics, rather than providing a comprehensive
195 reference to all things openable.  This rewrite came as the result of a
196 vigorous discussion on perl5-porters kicked off by a set of improvements
197 written by Alexander Hartmaier to the existing C<perlopentut>.  A "more than
198 you ever wanted to know about C<open>" document may follow in subsequent
199 versions of perl.
200
201 =back
202
203 =head1 Diagnostics
204
205 The following additions or changes have been made to diagnostic output,
206 including warnings and fatal error messages.  For the complete list of
207 diagnostic messages, see L<perldiag>.
208
209 XXX New or changed warnings emitted by the core's C<C> code go here.  Also
210 include any changes in L<perldiag> that reconcile it to the C<C> code.
211
212 =head2 New Diagnostics
213
214 XXX Newly added diagnostic messages go under here, separated into New Errors
215 and New Warnings
216
217 =head3 New Errors
218
219 =over 4
220
221 =item *
222
223 XXX L<message|perldiag/"message">
224
225 =back
226
227 =head3 New Warnings
228
229 =over 4
230
231 =item *
232
233 XXX L<message|perldiag/"message">
234
235 =back
236
237 =head2 Changes to Existing Diagnostics
238
239 XXX Changes (i.e. rewording) of diagnostic messages go here
240
241 =over 4
242
243 =item *
244
245 XXX Describe change here
246
247 =back
248
249 =head1 Utility Changes
250
251 XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here.
252 Most of these are built within the directories F<utils> and F<x2p>.
253
254 [ List utility changes as a =head3 entry for each utility and =item
255 entries for each change
256 Use L<XXX> with program names to get proper documentation linking. ]
257
258 =head3 L<XXX>
259
260 =over 4
261
262 =item *
263
264 XXX
265
266 =back
267
268 =head1 Configuration and Compilation
269
270 XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
271 go here.  Any other changes to the Perl build process should be listed here.
272 However, any platform-specific changes should be listed in the
273 L</Platform Support> section, instead.
274
275 [ List changes as a =item entry ].
276
277 =over 4
278
279 =item *
280
281 XXX
282
283 =back
284
285 =head1 Testing
286
287 XXX Any significant changes to the testing of a freshly built perl should be
288 listed here.  Changes which create B<new> files in F<t/> go here as do any
289 large changes to the testing harness (e.g. when parallel testing was added).
290 Changes to existing files in F<t/> aren't worth summarizing, although the bugs
291 that they represent may be covered elsewhere.
292
293 [ List each test improvement as a =item entry ]
294
295 =over 4
296
297 =item *
298
299 XXX
300
301 =back
302
303 =head1 Platform Support
304
305 XXX Any changes to platform support should be listed in the sections below.
306
307 [ Within the sections, list each platform as a =item entry with specific
308 changes as paragraphs below it. ]
309
310 =head2 New Platforms
311
312 XXX List any platforms that this version of perl compiles on, that previous
313 versions did not.  These will either be enabled by new files in the F<hints/>
314 directories, or new subdirectories and F<README> files at the top level of the
315 source tree.
316
317 =over 4
318
319 =item XXX-some-platform
320
321 XXX
322
323 =back
324
325 =head2 Discontinued Platforms
326
327 XXX List any platforms that this version of perl no longer compiles on.
328
329 =over 4
330
331 =item XXX-some-platform
332
333 XXX
334
335 =back
336
337 =head2 Platform-Specific Notes
338
339 XXX List any changes for specific platforms.  This could include configuration
340 and compilation changes or changes in portability/compatibility.  However,
341 changes within modules for platforms should generally be listed in the
342 L</Modules and Pragmata> section.
343
344 =over 4
345
346 =item XXX-some-platform
347
348 XXX
349
350 =back
351
352 =head1 Internal Changes
353
354 XXX Changes which affect the interface available to C<XS> code go here.  Other
355 significant internal changes for future core maintainers should be noted as
356 well.
357
358 [ List each change as a =item entry ]
359
360 =over 4
361
362 =item *
363
364 XXX
365
366 =back
367
368 =head1 Selected Bug Fixes
369
370 XXX Important bug fixes in the core language are summarized here.  Bug fixes in
371 files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>.
372
373 [ List each fix as a =item entry ]
374
375 =over 4
376
377 =item *
378
379 Autovivifying a subroutine stub via C<\&$glob> started causing crashes in
380 Perl 5.18.0 if the $glob was merely a copy of a real glob, i.e., a scalar
381 that had had a glob assigned to it.  This has been fixed [perl #119051].
382
383 =back
384
385 =head1 Known Problems
386
387 XXX Descriptions of platform agnostic bugs we know we can't fix go here.  Any
388 tests that had to be C<TODO>ed for the release would be noted here.  Unfixed
389 platform specific bugs also go here.
390
391 [ List each fix as a =item entry ]
392
393 =over 4
394
395 =item *
396
397 XXX
398
399 =back
400
401 =head1 Obituary
402
403 XXX If any significant core contributor has died, we've added a short obituary
404 here.
405
406 =head1 Acknowledgements
407
408 XXX Generate this with:
409
410   perl Porting/acknowledgements.pl v5.19.2..HEAD
411
412 =head1 Reporting Bugs
413
414 If you find what you think is a bug, you might check the articles recently
415 posted to the comp.lang.perl.misc newsgroup and the perl bug database at
416 http://rt.perl.org/perlbug/ .  There may also be information at
417 http://www.perl.org/ , the Perl Home Page.
418
419 If you believe you have an unreported bug, please run the L<perlbug> program
420 included with your release.  Be sure to trim your bug down to a tiny but
421 sufficient test case.  Your bug report, along with the output of C<perl -V>,
422 will be sent off to perlbug@perl.org to be analysed by the Perl porting team.
423
424 If the bug you are reporting has security implications, which make it
425 inappropriate to send to a publicly archived mailing list, then please send it
426 to perl5-security-report@perl.org.  This points to a closed subscription
427 unarchived mailing list, which includes all the core committers, who will be
428 able to help assess the impact of issues, figure out a resolution, and help
429 co-ordinate the release of patches to mitigate or fix the problem across all
430 platforms on which Perl is supported.  Please only use this address for
431 security issues in the Perl core, not for modules independently distributed on
432 CPAN.
433
434 =head1 SEE ALSO
435
436 The F<Changes> file for an explanation of how to view exhaustive details on
437 what changed.
438
439 The F<INSTALL> file for how to build Perl.
440
441 The F<README> file for general stuff.
442
443 The F<Artistic> and F<Copying> files for copyright information.
444
445 =cut