This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
4eb35816fd584071e0014760c7ee6b2822c1dcd9
[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 =head2 The C<\$> prototype accepts any scalar lvalue
37
38 The C<\$> and C<\[$]> subroutine prototypes now accept any scalar lvalue
39 argument.  Previously they only accepted scalars beginning with C<$> and
40 hash and array elements.  This change makes them consistent with the way
41 the built-in C<read> and C<recv> functions (among others) parse their
42 arguments. This means that one can override the built-in functions with
43 custom subroutines that parse their arguments the same way.
44
45 =head2 You can now C<study> more than one string
46
47 The restriction that you can only have one C<study> active at a time has been
48 removed. You can now usefully C<study> as many strings as you want (until you
49 exhaust memory).
50
51 =head1 Security
52
53 XXX Any security-related notices go here.  In particular, any security
54 vulnerabilities closed should be noted here rather than in the
55 L</Selected Bug Fixes> section.
56
57 [ List each security issue as a =head2 entry ]
58
59 =head1 Incompatible Changes
60
61 XXX For a release on a stable branch, this section aspires to be:
62
63     There are no changes intentionally incompatible with 5.XXX.XXX
64     If any exist, they are bugs and reports are welcome.
65
66 [ List each incompatible change as a =head2 entry ]
67
68 =head1 Deprecations
69
70 XXX Any deprecated features, syntax, modules etc. should be listed here.
71 In particular, deprecated modules should be listed here even if they are
72 listed as an updated module in the L</Modules and Pragmata> section.
73
74 [ List each deprecation as a =head2 entry ]
75
76 =head1 Performance Enhancements
77
78 XXX Changes which enhance performance without changing behaviour go here. There
79 may well be none in a stable release.
80
81 [ List each enhancement as a =item entry ]
82
83 =over 4
84
85 =item *
86
87 The implementation of C<s///r> makes one fewer copy of the scalar's value.
88
89 =item *
90
91 If a studied scalar is C<split> with a regex, the engine will now take
92 advantage of the C<study> data.
93
94 =item *
95
96 C<study> now uses considerably less memory for shorter strings. Strings shorter
97 than 65535 characters use roughly half the memory than previously, strings
98 shorter than 255 characters use roughly one quarter of the memory.
99
100 =back
101
102 =head1 Modules and Pragmata
103
104 XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
105 go here.  If Module::CoreList is updated, generate an initial draft of the
106 following sections using F<Porting/corelist-perldelta.pl>, which prints stub
107 entries to STDOUT.  Results can be pasted in place of the '=head2' entries
108 below.  A paragraph summary for important changes should then be added by hand.
109 In an ideal world, dual-life modules would have a F<Changes> file that could be
110 cribbed.
111
112 [ Within each section, list entries as a =item entry ]
113
114 =head2 New Modules and Pragmata
115
116 =over 4
117
118 =item *
119
120 XXX
121
122 =back
123
124 =head2 Updated Modules and Pragmata
125
126 =over 4
127
128 =item *
129
130 L<Compress::Raw::Bzip2> has been upgraded from version 2.035 to version 2.037
131
132 =item *
133
134 L<Compress::Raw::Zlib> has been upgraded from version 2.035 to version 2.037
135
136 Added offset parameter to CRC32
137
138 =item *
139
140 L<Compress::Zlib> has been upgraded from version 2.035 to version 2.037
141
142 IO::Compress::Zip and IO::Uncompress::Unzip now have support for LZMA (method 14).
143 There is a fix for a CRC issue in IO::Compress::Unzip and it supports Streamed
144 Stored context now. And fixed a Zip64 issue in
145 IO::Compress::Zip when the content size was exactly 0xFFFFFFFF.
146
147 =item *
148
149 L<CPANPLUS> has been upgraded from version 0.9105 to version 0.9106
150
151 =item *
152
153 L<ExtUtils::MakeMaker> has been upgraded from version 6.57_05 to version 6.58
154
155 =item *
156
157 L<IPC::Cmd> has been upgraded from version 0.70 to version 0.72
158
159 Capturing of command output (both C<STDOUT> and C<STDERR>) is now supported
160 using L<IPC::Open3> on MSWin32 without requiring L<IPC::Run>.
161
162 =item *
163
164 L<Locale::Codes> has been upgraded from version 3.16 to version 3.17
165
166 Added Language Extension codes (langext) and Language Variation codes
167 (langvar) as defined in the IANA language registry.
168
169 Added language codes from ISO 639-5
170
171 Added language/script codes from the IANA language subtag
172 registry
173
174 Fixed an uninitialized value warning.  RT 67438
175
176 Fixed the return value for the all_XXX_codes and all_XXX_names functions.  RT 69100
177
178 Reorganized modules to move Locale::MODULE to Locale::Codes::MODULE to
179 allow for cleaner future additions.  The original four modules (Locale::Language,
180 Locale::Currency, Locale::Country, Locale::Script) will continue to work, but
181 all new sets of codes will be added in the Locale::Codes namespace.
182
183 =item *
184
185 L<attributes> has been upgraded from version 0.14 to 0.15, as part of the
186 lvalue attribute warnings fix.  See L</Selected Bug Fixes>, below.
187
188 =item *
189
190 L<Math::BigInt::FastCalc> has been upgraded from version 0.28 to version 0.29.
191
192 The XS code is now compiled with C<PERL_NO_GET_CONTEXT>, which will aid
193 performance under ithreads.
194
195 =item *
196
197 L<Unicode::Collate> has been upgraded from version 0.76 to version 0.77
198
199 Applied [perl #93470] silencing compiler warnings with -Wwrite-strings
200
201 =item *
202
203 L<Win32API::File> has been upgraded from version 0.1101 to version 0.1200
204
205 Added SetStdHandle and GetStdHandle functions
206
207 =item *
208
209 L<threads> has been upgraded from version 1.83 to 1.84
210
211 An unused variable was removed from the XS code.
212
213 =back
214
215 =head2 Removed Modules and Pragmata
216
217 =over 4
218
219 =item *
220
221 Perl 4-era .pl libraries
222
223 Perl used to bundle a handful of library files that predate Perl 5. Most of
224 these files, which have been deprecated since version 5.14.0, have now been
225 removed. If your code still relies on these libraries, you can install them
226 again from C<Perl4::CoreLibs> on CPAN.
227
228 =back
229
230 =head1 Documentation
231
232 XXX Changes to files in F<pod/> go here.  Consider grouping entries by
233 file and be sure to link to the appropriate page, e.g. L<perlfunc>.
234
235 =head2 New Documentation
236
237 XXX Changes which create B<new> files in F<pod/> go here.
238
239 =head3 L<XXX>
240
241 XXX Description of the purpose of the new file here
242
243 =head2 Changes to Existing Documentation
244
245 XXX Changes which significantly change existing files in F<pod/> go here.
246 However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
247 section.
248
249 =head3 L<XXX>
250
251 =over 4
252
253 =item *
254
255 XXX Description of the change here
256
257 =back
258
259 =head1 Diagnostics
260
261 The following additions or changes have been made to diagnostic output,
262 including warnings and fatal error messages.  For the complete list of
263 diagnostic messages, see L<perldiag>.
264
265 XXX New or changed warnings emitted by the core's C<C> code go here. Also
266 include any changes in L<perldiag> that reconcile it to the C<C> code.
267
268 [ Within each section, list entries as a =item entry that links to perldiag,
269   e.g.
270
271   =item *
272
273   L<Invalid version object|perldiag/"Invalid version object">
274 ]
275
276 =head2 New Diagnostics
277
278 XXX Newly added diagnostic messages go here
279
280 =head3 New Errors
281
282 =over 4
283
284 =item *
285
286 XXX L<message|perldiag/"message">
287
288 =back
289
290 =head3 New Warnings
291
292 =over 4
293
294 =item *
295
296 XXX L<message|perldiag/"message">
297
298 =back
299
300 =head2 Changes to Existing Diagnostics
301
302 XXX Changes (i.e. rewording) of diagnostic messages go here
303
304 =over 4
305
306 =item *
307
308 XXX Describe change here
309
310 =back
311
312 =head1 Utility Changes
313
314 XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go
315 here. Most of these are built within the directories F<utils> and F<x2p>.
316
317 [ List utility changes as a =head3 entry for each utility and =item
318 entries for each change
319 Use L<XXX> with program names to get proper documentation linking. ]
320
321 =head3 L<XXX>
322
323 =over 4
324
325 =item *
326
327 XXX
328
329 =back
330
331 =head1 Configuration and Compilation
332
333 XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
334 go here.  Any other changes to the Perl build process should be listed here.
335 However, any platform-specific changes should be listed in the
336 L</Platform Support> section, instead.
337
338 [ List changes as a =item entry ].
339
340 =over 4
341
342 =item *
343
344 XXX
345
346 =back
347
348 =head1 Testing
349
350 XXX Any significant changes to the testing of a freshly built perl should be
351 listed here.  Changes which create B<new> files in F<t/> go here as do any
352 large changes to the testing harness (e.g. when parallel testing was added).
353 Changes to existing files in F<t/> aren't worth summarising, although the bugs
354 that they represent may be covered elsewhere.
355
356 [ List each test improvement as a =item entry ]
357
358 =over 4
359
360 =item *
361
362 XXX
363
364 =back
365
366 =head1 Platform Support
367
368 XXX Any changes to platform support should be listed in the sections below.
369
370 [ Within the sections, list each platform as a =item entry with specific
371 changes as paragraphs below it. ]
372
373 =head2 New Platforms
374
375 XXX List any platforms that this version of perl compiles on, that previous
376 versions did not. These will either be enabled by new files in the F<hints/>
377 directories, or new subdirectories and F<README> files at the top level of the
378 source tree.
379
380 =over 4
381
382 =item XXX-some-platform
383
384 XXX
385
386 =back
387
388 =head2 Discontinued Platforms
389
390 XXX List any platforms that this version of perl no longer compiles on.
391
392 =over 4
393
394 =item XXX-some-platform
395
396 XXX
397
398 =back
399
400 =head2 Platform-Specific Notes
401
402 XXX List any changes for specific platforms. This could include configuration
403 and compilation changes or changes in portability/compatibility.  However,
404 changes within modules for platforms should generally be listed in the
405 L</Modules and Pragmata> section.
406
407 =over 4
408
409 =item XXX-some-platform
410
411 XXX
412
413 =back
414
415 =head1 Internal Changes
416
417 XXX Changes which affect the interface available to C<XS> code go here.
418 Other significant internal changes for future core maintainers should
419 be noted as well.
420
421 [ List each change as a =item entry ]
422
423 =over 4
424
425 =item *
426
427 XXX
428
429 =back
430
431 =head1 Selected Bug Fixes
432
433 XXX Important bug fixes in the core language are summarised here.
434 Bug fixes in files in F<ext/> and F<lib/> are best summarised in
435 L</Modules and Pragmata>.
436
437 [ List each fix as a =item entry ]
438
439 =over 4
440
441 =item *
442
443 Applying the :lvalue attribute to subroutine that is already defined does
444 not work properly, as the attribute changes the way the sub is compiled.
445 Hence, Perl 5.12 began warning when an attempt is made to apply the
446 attribute to an already defined sub.  In such cases, the attribute is
447 discarded.
448
449 But the change in 5.12 missed the case where custom attributes are also
450 present: that case still silently and ineffectively applied the attribute.
451 That omission has now been corrected.  C<sub foo :lvalue :Whatever> (when
452 C<foo> is already defined) now warns about the :lvalue attribute, and does
453 not apply it.
454
455 L<attributes.pm|attributes> has likewise been updated to warn and not apply
456 the attribute.
457
458 =item *
459
460 =for comment
461 Not necessary for perl5160delta
462
463 The remaining discrepancies between explicit and implicit return from
464 lvalue subroutines have been resolved.  They mainly involved which error
465 message to display when a read-only value is returned in lvalue context.
466 Also, returning a PADTMP (the result of most built-ins, like C<index>) in
467 lvalue context is now forbidden for explicit return, as it always has been
468 for implicit return.  This is not a regression from 5.14, as all the cases
469 in which it could happen where previously syntax errors.
470
471 =item *
472
473 =for comment
474 Not necessary for perl5160delta
475
476 Explicitly returning a tied C<my> variable from an lvalue subroutine in
477 list lvalue context used to clear the variable before the assignment could
478 happen.  This is something that was missed when explicit return was made to
479 work in 5.15.0.
480
481 =item *
482
483 =for comment
484 Not necessary for perl5160delta
485
486 A minor memory leak, introduced in 5.15.0, has been fixed.  It would occur
487 when a hash is freed that has had its current iterator deleted
488 [perl #93454].
489
490 =item *
491
492 The C<prototype> function now returns a prototype (the empty string) for
493 the C<__FILE__>, C<__LINE__> and C<__PACKAGE__> directives, instead of
494 dying, as they are indistinguishable syntactically from nullary functions
495 like C<time>.
496
497 =back
498
499 =head1 Known Problems
500
501 XXX Descriptions of platform agnostic bugs we know we can't fix go here. Any
502 tests that had to be C<TODO>ed for the release would be noted here, unless
503 they were specific to a particular platform (see below).
504
505 This is a list of some significant unfixed bugs, which are regressions
506 from either 5.XXX.XXX or 5.XXX.XXX.
507
508 [ List each fix as a =item entry ]
509
510 =over 4
511
512 =item *
513
514 XXX
515
516 =back
517
518 =head1 Obituary
519
520 XXX If any significant core contributor has died, we've added a short obituary
521 here.
522
523 =head1 Acknowledgements
524
525 XXX The list of people to thank goes here.
526
527 =head1 Reporting Bugs
528
529 If you find what you think is a bug, you might check the articles
530 recently posted to the comp.lang.perl.misc newsgroup and the perl
531 bug database at http://rt.perl.org/perlbug/ .  There may also be
532 information at http://www.perl.org/ , the Perl Home Page.
533
534 If you believe you have an unreported bug, please run the L<perlbug>
535 program included with your release.  Be sure to trim your bug down
536 to a tiny but sufficient test case.  Your bug report, along with the
537 output of C<perl -V>, will be sent off to perlbug@perl.org to be
538 analysed by the Perl porting team.
539
540 If the bug you are reporting has security implications, which make it
541 inappropriate to send to a publicly archived mailing list, then please send
542 it to perl5-security-report@perl.org. This points to a closed subscription
543 unarchived mailing list, which includes
544 all the core committers, who will be able
545 to help assess the impact of issues, figure out a resolution, and help
546 co-ordinate the release of patches to mitigate or fix the problem across all
547 platforms on which Perl is supported. Please only use this address for
548 security issues in the Perl core, not for modules independently
549 distributed on CPAN.
550
551 =head1 SEE ALSO
552
553 The F<Changes> file for an explanation of how to view exhaustive details
554 on what changed.
555
556 The F<INSTALL> file for how to build Perl.
557
558 The F<README> file for general stuff.
559
560 The F<Artistic> and F<Copying> files for copyright information.
561
562 =cut