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