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