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