This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
37c4dc92b2692a6d7048c6138864c1cf3f44fd88
[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.1
9
10 =head1 DESCRIPTION
11
12 This document describes differences between the 5.15.1 release and
13 the 5.15.0 release.
14
15 If you are upgrading from an earlier release such as 5.14.0, first read
16 L<perl5150delta>, which describes differences between 5.14.0 and
17 5.15.0.
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 =head2 C<splice()> doesn't warn when truncating
32
33 You can now limit the size of an array using C<splice(@a,MAX_LEN)> without
34 worrying about warnings.
35
36 =head1 Security
37
38 XXX Any security-related notices go here.  In particular, any security
39 vulnerabilities closed should be noted here rather than in the
40 L</Selected Bug Fixes> section.
41
42 [ List each security issue as a =head2 entry ]
43
44 =head1 Incompatible Changes
45
46 XXX For a release on a stable branch, this section aspires to be:
47
48     There are no changes intentionally incompatible with 5.XXX.XXX
49     If any exist, they are bugs and reports are welcome.
50
51 [ List each incompatible change as a =head2 entry ]
52
53 =head1 Deprecations
54
55 XXX Any deprecated features, syntax, modules etc. should be listed here.
56 In particular, deprecated modules should be listed here even if they are
57 listed as an updated module in the L</Modules and Pragmata> section.
58
59 [ List each deprecation as a =head2 entry ]
60
61 =head1 Performance Enhancements
62
63 XXX Changes which enhance performance without changing behaviour go here. There
64 may well be none in a stable release.
65
66 [ List each enhancement as a =item entry ]
67
68 =over 4
69
70 =item *
71
72 XXX
73
74 =back
75
76 =head1 Modules and Pragmata
77
78 XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
79 go here.  If Module::CoreList is updated, generate an initial draft of the
80 following sections using F<Porting/corelist-perldelta.pl>, which prints stub
81 entries to STDOUT.  Results can be pasted in place of the '=head2' entries
82 below.  A paragraph summary for important changes should then be added by hand.
83 In an ideal world, dual-life modules would have a F<Changes> file that could be
84 cribbed.
85
86 [ Within each section, list entries as a =item entry ]
87
88 =head2 New Modules and Pragmata
89
90 =over 4
91
92 =item *
93
94 XXX
95
96 =back
97
98 =head2 Updated Modules and Pragmata
99
100 =over 4
101
102 =item *
103
104 L<Compress::Raw::Bzip2> has been upgraded from version 2.035 to version 2.037
105
106 =item *
107
108 L<Compress::Raw::Zlib> has been upgraded from version 2.035 to version 2.037
109
110 Added offset parameter to CRC32
111
112 =item *
113
114 L<Compress::Zlib> has been upgraded from version 2.035 to version 2.037
115
116 IO::Compress::Zip and IO::Uncompress::Unzip now have support for LZMA (method 14).
117 There is a fix for a CRC issue in IO::Compress::Unzip and it supports Streamed
118 Stored context now. And fixed a Zip64 issue in
119 IO::Compress::Zip when the content size was exactly 0xFFFFFFFF.
120
121 =item *
122
123 L<IPC::Cmd> has been upgraded from version 0.70 to version 0.72
124
125 Capturing of command output (both C<STDOUT> and C<STDERR>) is now supported
126 using L<IPC::Open3> on MSWin32 without requiring L<IPC::Run>.
127
128 =item *
129
130 L<attributes> has been upgraded from version 0.14 to 0.15, as part of the
131 lvalue attribute warnings fix.  See L</Selected Bug Fixes>, below.
132
133 =item *
134
135 L<Math::BigInt::FastCalc> has been upgraded from version 0.28 to version 0.29.
136
137 The XS code is now compiled with C<PERL_NO_GET_CONTEXT>, which will aid
138 performance under ithreads.
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 [ Within each section, list entries as a =item entry that links to perldiag,
191   e.g.
192
193   =item *
194
195   L<Invalid version object|perldiag/"Invalid version object">
196 ]
197
198 =head2 New Diagnostics
199
200 XXX Newly added diagnostic messages go here
201
202 =head3 New Errors
203
204 =over 4
205
206 =item *
207
208 XXX L<message|perldiag/"message">
209
210 =back
211
212 =head3 New Warnings
213
214 =over 4
215
216 =item *
217
218 XXX L<message|perldiag/"message">
219
220 =back
221
222 =head2 Changes to Existing Diagnostics
223
224 XXX Changes (i.e. rewording) of diagnostic messages go here
225
226 =over 4
227
228 =item *
229
230 XXX Describe change here
231
232 =back
233
234 =head1 Utility Changes
235
236 XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go
237 here. Most of these are built within the directories F<utils> and F<x2p>.
238
239 [ List utility changes as a =head3 entry for each utility and =item
240 entries for each change
241 Use L<XXX> with program names to get proper documentation linking. ]
242
243 =head3 L<XXX>
244
245 =over 4
246
247 =item *
248
249 XXX
250
251 =back
252
253 =head1 Configuration and Compilation
254
255 XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
256 go here.  Any other changes to the Perl build process should be listed here.
257 However, any platform-specific changes should be listed in the
258 L</Platform Support> section, instead.
259
260 [ List changes as a =item entry ].
261
262 =over 4
263
264 =item *
265
266 XXX
267
268 =back
269
270 =head1 Testing
271
272 XXX Any significant changes to the testing of a freshly built perl should be
273 listed here.  Changes which create B<new> files in F<t/> go here as do any
274 large changes to the testing harness (e.g. when parallel testing was added).
275 Changes to existing files in F<t/> aren't worth summarising, although the bugs
276 that they represent may be covered elsewhere.
277
278 [ List each test improvement as a =item entry ]
279
280 =over 4
281
282 =item *
283
284 XXX
285
286 =back
287
288 =head1 Platform Support
289
290 XXX Any changes to platform support should be listed in the sections below.
291
292 [ Within the sections, list each platform as a =item entry with specific
293 changes as paragraphs below it. ]
294
295 =head2 New Platforms
296
297 XXX List any platforms that this version of perl compiles on, that previous
298 versions did not. These will either be enabled by new files in the F<hints/>
299 directories, or new subdirectories and F<README> files at the top level of the
300 source tree.
301
302 =over 4
303
304 =item XXX-some-platform
305
306 XXX
307
308 =back
309
310 =head2 Discontinued Platforms
311
312 XXX List any platforms that this version of perl no longer compiles on.
313
314 =over 4
315
316 =item XXX-some-platform
317
318 XXX
319
320 =back
321
322 =head2 Platform-Specific Notes
323
324 XXX List any changes for specific platforms. This could include configuration
325 and compilation changes or changes in portability/compatibility.  However,
326 changes within modules for platforms should generally be listed in the
327 L</Modules and Pragmata> section.
328
329 =over 4
330
331 =item XXX-some-platform
332
333 XXX
334
335 =back
336
337 =head1 Internal Changes
338
339 XXX Changes which affect the interface available to C<XS> code go here.
340 Other significant internal changes for future core maintainers should
341 be noted as well.
342
343 [ List each change as a =item entry ]
344
345 =over 4
346
347 =item *
348
349 XXX
350
351 =back
352
353 =head1 Selected Bug Fixes
354
355 XXX Important bug fixes in the core language are summarised here.
356 Bug fixes in files in F<ext/> and F<lib/> are best summarised in
357 L</Modules and Pragmata>.
358
359 [ List each fix as a =item entry ]
360
361 =over 4
362
363 =item *
364
365 Applying the :lvalue attribute to subroutine that is already defined does
366 not work properly, as the attribute changes the way the sub is compiled.
367 Hence, Perl 5.12 began warning when an attempt is made to apply the
368 attribute to an already defined sub.  In such cases, the attribute is
369 discarded.
370
371 But the change in 5.12 missed the case where custom attributes are also
372 present: that case still silently and ineffectively applied the attribute.
373 That omission has now been corrected.  C<sub foo :lvalue :Whatever> (when
374 C<foo> is already defined) now warns about the :lvalue attribute, and does
375 not apply it.
376
377 L<attributes.pm|attributes> has likewise been updated to warn and not apply
378 the attribute.
379
380 =back
381
382 =head1 Known Problems
383
384 XXX Descriptions of platform agnostic bugs we know we can't fix go here. Any
385 tests that had to be C<TODO>ed for the release would be noted here, unless
386 they were specific to a particular platform (see below).
387
388 This is a list of some significant unfixed bugs, which are regressions
389 from either 5.XXX.XXX or 5.XXX.XXX.
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 The list of people to thank goes here.
409
410 =head1 Reporting Bugs
411
412 If you find what you think is a bug, you might check the articles
413 recently posted to the comp.lang.perl.misc newsgroup and the perl
414 bug database at http://rt.perl.org/perlbug/ .  There may also be
415 information at http://www.perl.org/ , the Perl Home Page.
416
417 If you believe you have an unreported bug, please run the L<perlbug>
418 program included with your release.  Be sure to trim your bug down
419 to a tiny but sufficient test case.  Your bug report, along with the
420 output of C<perl -V>, will be sent off to perlbug@perl.org to be
421 analysed by the Perl porting team.
422
423 If the bug you are reporting has security implications, which make it
424 inappropriate to send to a publicly archived mailing list, then please send
425 it to perl5-security-report@perl.org. This points to a closed subscription
426 unarchived mailing list, which includes
427 all the core committers, who will be able
428 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
432 distributed on CPAN.
433
434 =head1 SEE ALSO
435
436 The F<Changes> file for an explanation of how to view exhaustive details
437 on 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