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