This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
a20d73fd7181784934fb52a239eacca626163d66
[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
6 XXX needs to be processed before release. ]
7
8 perldelta - what is new for perl v5.15.5
9
10 =head1 DESCRIPTION
11
12 This document describes differences between the 5.15.4 release and
13 the 5.15.5 release.
14
15 If you are upgrading from an earlier release such as 5.15.3, first read
16 L<perl5154delta>, which describes differences between 5.15.3 and
17 5.15.4.
18
19 =head1 Notice
20
21 XXX Any important notices here
22
23 =head1 Core Enhancements
24
25 XXX New core language features go here. Summarise user-visible core language
26 enhancements. Particularly prominent performance optimisations could go
27 here, but most should go in the L</Performance Enhancements> section.
28
29 [ List each enhancement as a =head2 entry ]
30
31 =head1 Security
32
33 XXX Any security-related notices go here.  In particular, any security
34 vulnerabilities closed should be noted here rather than in the
35 L</Selected Bug Fixes> section.
36
37 [ List each security issue as a =head2 entry ]
38
39 =head1 Incompatible Changes
40
41 XXX For a release on a stable branch, this section aspires to be:
42
43     There are no changes intentionally incompatible with 5.XXX.XXX
44     If any exist, they are bugs and reports are welcome.
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 In particular, deprecated modules should be listed here even if they are
52 listed as an updated module in the L</Modules and Pragmata> section.
53
54 [ List each deprecation as a =head2 entry ]
55
56 =head1 Performance Enhancements
57
58 XXX Changes which enhance performance without changing behaviour go here. There
59 may well be none in a stable release.
60
61 [ List each enhancement as a =item entry ]
62
63 =over 4
64
65 =item *
66
67 XXX
68
69 =back
70
71 =head1 Modules and Pragmata
72
73 XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
74 go here.  If Module::CoreList is updated, generate an initial draft of the
75 following sections using F<Porting/corelist-perldelta.pl>, which prints stub
76 entries to STDOUT.  Results can be pasted in place of the '=head2' entries
77 below.  A paragraph summary for important changes should then be added by hand.
78 In an ideal world, dual-life modules would have a F<Changes> file that could be
79 cribbed.
80
81 [ Within each section, list entries as a =item entry ]
82
83 =head2 New Modules and Pragmata
84
85 =over 4
86
87 =item *
88
89 XXX
90
91 =back
92
93 =head2 Updated Modules and Pragmata
94
95 =over 4
96
97 =item *
98
99 L<Archive::Extract> has been upgraded from version 0.56 to version 0.58.
100
101 =item *
102
103 L<CPANPLUS::Dist::Build> has been upgraded from version 0.58 to version 0.60.
104
105 =item *
106
107 L<ExtUtils::MakeMaker> has been upgraded from version 6.61_01 to version 6.63_01.
108
109 =item *
110
111 L<HTTP::Tiny> has been upgraded from version 0.013 to version 0.016.
112
113 Adds additional shorthand methods for all common HTTP verbs,
114 a C<post_form()> method for POST-ing x-www-form-urlencoded data and
115 a C<www_form_urlencode()> utility method.
116
117 =item *
118
119 L<perlfaq> has been upgraded from version 5.0150035 to version 5.0150036.
120
121 =item *
122
123 L<Unicode::Collate> has been upgraded from version 0.80 to version 0.81.
124
125 Locales updated to CLDR 2.0: mk, mt, nb, nn, ro, ru.
126 Newly supported locales: ml, mr, or, pa.
127
128 =back
129
130 =head2 Removed Modules and Pragmata
131
132 =over 4
133
134 =item *
135
136 XXX
137
138 =back
139
140 =head1 Documentation
141
142 XXX Changes to files in F<pod/> go here.  Consider grouping entries by
143 file and be sure to link to the appropriate page, e.g. L<perlfunc>.
144
145 =head2 New Documentation
146
147 XXX Changes which create B<new> files in F<pod/> go here.
148
149 =head3 L<XXX>
150
151 XXX Description of the purpose of the new file here
152
153 =head2 Changes to Existing Documentation
154
155 XXX Changes which significantly change existing files in F<pod/> go here.
156 However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
157 section.
158
159 =head3 L<XXX>
160
161 =over 4
162
163 =item *
164
165 XXX Description of the change here
166
167 =back
168
169 =head1 Diagnostics
170
171 The following additions or changes have been made to diagnostic output,
172 including warnings and fatal error messages.  For the complete list of
173 diagnostic messages, see L<perldiag>.
174
175 XXX New or changed warnings emitted by the core's C<C> code go here. Also
176 include any changes in L<perldiag> that reconcile it to the C<C> code.
177
178 [ Within each section, list entries as a =item entry that links to perldiag,
179   e.g.
180
181   =item *
182
183   L<Invalid version object|perldiag/"Invalid version object">
184 ]
185
186 =head2 New Diagnostics
187
188 XXX Newly added diagnostic messages go here
189
190 =head3 New Errors
191
192 =over 4
193
194 =item *
195
196 XXX L<message|perldiag/"message">
197
198 =back
199
200 =head3 New Warnings
201
202 =over 4
203
204 =item *
205
206 XXX L<message|perldiag/"message">
207
208 =back
209
210 =head2 Changes to Existing Diagnostics
211
212 XXX Changes (i.e. rewording) of diagnostic messages go here
213
214 =over 4
215
216 =item *
217
218 XXX Describe change here
219
220 =back
221
222 =head1 Utility Changes
223
224 XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go
225 here. Most of these are built within the directories F<utils> and F<x2p>.
226
227 [ List utility changes as a =head3 entry for each utility and =item
228 entries for each change
229 Use L<XXX> with program names to get proper documentation linking. ]
230
231 =head3 L<XXX>
232
233 =over 4
234
235 =item *
236
237 XXX
238
239 =back
240
241 =head1 Configuration and Compilation
242
243 XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
244 go here.  Any other changes to the Perl build process should be listed here.
245 However, any platform-specific changes should be listed in the
246 L</Platform Support> section, instead.
247
248 [ List changes as a =item entry ].
249
250 =over 4
251
252 =item *
253
254 XXX
255
256 =back
257
258 =head1 Testing
259
260 XXX Any significant changes to the testing of a freshly built perl should be
261 listed here.  Changes which create B<new> files in F<t/> go here as do any
262 large changes to the testing harness (e.g. when parallel testing was added).
263 Changes to existing files in F<t/> aren't worth summarising, although the bugs
264 that they represent may be covered elsewhere.
265
266 [ List each test improvement as a =item entry ]
267
268 =over 4
269
270 =item *
271
272 XXX
273
274 =back
275
276 =head1 Platform Support
277
278 XXX Any changes to platform support should be listed in the sections below.
279
280 [ Within the sections, list each platform as a =item entry with specific
281 changes as paragraphs below it. ]
282
283 =head2 New Platforms
284
285 XXX List any platforms that this version of perl compiles on, that previous
286 versions did not. These will either be enabled by new files in the F<hints/>
287 directories, or new subdirectories and F<README> files at the top level of the
288 source tree.
289
290 =over 4
291
292 =item XXX-some-platform
293
294 XXX
295
296 =back
297
298 =head2 Discontinued Platforms
299
300 XXX List any platforms that this version of perl no longer compiles on.
301
302 =over 4
303
304 =item XXX-some-platform
305
306 XXX
307
308 =back
309
310 =head2 Platform-Specific Notes
311
312 XXX List any changes for specific platforms. This could include configuration
313 and compilation changes or changes in portability/compatibility.  However,
314 changes within modules for platforms should generally be listed in the
315 L</Modules and Pragmata> section.
316
317 =over 4
318
319 =item XXX-some-platform
320
321 XXX
322
323 =back
324
325 =head1 Internal Changes
326
327 XXX Changes which affect the interface available to C<XS> code go here.
328 Other significant internal changes for future core maintainers should
329 be noted as well.
330
331 [ List each change as a =item entry ]
332
333 =over 4
334
335 =item *
336
337 XXX
338
339 =back
340
341 =head1 Selected Bug Fixes
342
343 XXX Important bug fixes in the core language are summarised here.
344 Bug fixes in files in F<ext/> and F<lib/> are best summarised in
345 L</Modules and Pragmata>.
346
347 [ List each fix as a =item entry ]
348
349 =over 4
350
351 =item *
352
353 XXX
354
355 =back
356
357 =head1 Known Problems
358
359 XXX Descriptions of platform agnostic bugs we know we can't fix go here. Any
360 tests that had to be C<TODO>ed for the release would be noted here, unless
361 they were specific to a particular platform (see below).
362
363 This is a list of some significant unfixed bugs, which are regressions
364 from either 5.XXX.XXX or 5.XXX.XXX.
365
366 [ List each fix as a =item entry ]
367
368 =over 4
369
370 =item *
371
372 XXX
373
374 =back
375
376 =head1 Obituary
377
378 XXX If any significant core contributor has died, we've added a short obituary
379 here.
380
381 =head1 Acknowledgements
382
383 XXX Generate this with:
384
385   perl Porting/acknowledgements.pl v5.15.4..HEAD
386
387 =head1 Reporting Bugs
388
389 If you find what you think is a bug, you might check the articles
390 recently posted to the comp.lang.perl.misc newsgroup and the perl
391 bug database at http://rt.perl.org/perlbug/ .  There may also be
392 information at http://www.perl.org/ , the Perl Home Page.
393
394 If you believe you have an unreported bug, please run the L<perlbug>
395 program included with your release.  Be sure to trim your bug down
396 to a tiny but sufficient test case.  Your bug report, along with the
397 output of C<perl -V>, will be sent off to perlbug@perl.org to be
398 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
402 it to perl5-security-report@perl.org. This points to a closed subscription
403 unarchived mailing list, which includes
404 all the core committers, who will be able
405 to help assess the impact of issues, figure out a resolution, and help
406 co-ordinate the release of patches to mitigate or fix the problem across all
407 platforms on which Perl is supported. Please only use this address for
408 security issues in the Perl core, not for modules independently
409 distributed on CPAN.
410
411 =head1 SEE ALSO
412
413 The F<Changes> file for an explanation of how to view exhaustive details
414 on what changed.
415
416 The F<INSTALL> file for how to build Perl.
417
418 The F<README> file for general stuff.
419
420 The F<Artistic> and F<Copying> files for copyright information.
421
422 =cut