This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
For shorter strings, store C<study>'s data as U8s or U16s, instead of U32s.
[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<IPC::Cmd> has been upgraded from version 0.70 to version 0.72
150
151 Capturing of command output (both C<STDOUT> and C<STDERR>) is now supported
152 using L<IPC::Open3> on MSWin32 without requiring L<IPC::Run>.
153
154 =item *
155
156 L<Locale::Codes> has been upgraded from version 3.16 to version 3.17
157
158 Added Language Extension codes (langext) and Language Variation codes
159 (langvar) as defined in the IANA language registry.
160
161 Added language codes from ISO 639-5
162
163 Added language/script codes from the IANA language subtag
164 registry
165
166 Fixed an uninitialized value warning.  RT 67438
167
168 Fixed the return value for the all_XXX_codes and all_XXX_names functions.  RT 69100
169
170 Reorganized modules to move Locale::MODULE to Locale::Codes::MODULE to
171 allow for cleaner future additions.  The original four modules (Locale::Language,
172 Locale::Currency, Locale::Country, Locale::Script) will continue to work, but
173 all new sets of codes will be added in the Locale::Codes namespace.
174
175 =item *
176
177 L<attributes> has been upgraded from version 0.14 to 0.15, as part of the
178 lvalue attribute warnings fix.  See L</Selected Bug Fixes>, below.
179
180 =item *
181
182 L<Math::BigInt::FastCalc> has been upgraded from version 0.28 to version 0.29.
183
184 The XS code is now compiled with C<PERL_NO_GET_CONTEXT>, which will aid
185 performance under ithreads.
186
187 =back
188
189 =head2 Removed Modules and Pragmata
190
191 =over 4
192
193 =item *
194
195 XXX
196
197 =back
198
199 =head1 Documentation
200
201 XXX Changes to files in F<pod/> go here.  Consider grouping entries by
202 file and be sure to link to the appropriate page, e.g. L<perlfunc>.
203
204 =head2 New Documentation
205
206 XXX Changes which create B<new> files in F<pod/> go here.
207
208 =head3 L<XXX>
209
210 XXX Description of the purpose of the new file here
211
212 =head2 Changes to Existing Documentation
213
214 XXX Changes which significantly change existing files in F<pod/> go here.
215 However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
216 section.
217
218 =head3 L<XXX>
219
220 =over 4
221
222 =item *
223
224 XXX Description of the change here
225
226 =back
227
228 =head1 Diagnostics
229
230 The following additions or changes have been made to diagnostic output,
231 including warnings and fatal error messages.  For the complete list of
232 diagnostic messages, see L<perldiag>.
233
234 XXX New or changed warnings emitted by the core's C<C> code go here. Also
235 include any changes in L<perldiag> that reconcile it to the C<C> code.
236
237 [ Within each section, list entries as a =item entry that links to perldiag,
238   e.g.
239
240   =item *
241
242   L<Invalid version object|perldiag/"Invalid version object">
243 ]
244
245 =head2 New Diagnostics
246
247 XXX Newly added diagnostic messages go here
248
249 =head3 New Errors
250
251 =over 4
252
253 =item *
254
255 XXX L<message|perldiag/"message">
256
257 =back
258
259 =head3 New Warnings
260
261 =over 4
262
263 =item *
264
265 XXX L<message|perldiag/"message">
266
267 =back
268
269 =head2 Changes to Existing Diagnostics
270
271 XXX Changes (i.e. rewording) of diagnostic messages go here
272
273 =over 4
274
275 =item *
276
277 XXX Describe change here
278
279 =back
280
281 =head1 Utility Changes
282
283 XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go
284 here. Most of these are built within the directories F<utils> and F<x2p>.
285
286 [ List utility changes as a =head3 entry for each utility and =item
287 entries for each change
288 Use L<XXX> with program names to get proper documentation linking. ]
289
290 =head3 L<XXX>
291
292 =over 4
293
294 =item *
295
296 XXX
297
298 =back
299
300 =head1 Configuration and Compilation
301
302 XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
303 go here.  Any other changes to the Perl build process should be listed here.
304 However, any platform-specific changes should be listed in the
305 L</Platform Support> section, instead.
306
307 [ List changes as a =item entry ].
308
309 =over 4
310
311 =item *
312
313 XXX
314
315 =back
316
317 =head1 Testing
318
319 XXX Any significant changes to the testing of a freshly built perl should be
320 listed here.  Changes which create B<new> files in F<t/> go here as do any
321 large changes to the testing harness (e.g. when parallel testing was added).
322 Changes to existing files in F<t/> aren't worth summarising, although the bugs
323 that they represent may be covered elsewhere.
324
325 [ List each test improvement as a =item entry ]
326
327 =over 4
328
329 =item *
330
331 XXX
332
333 =back
334
335 =head1 Platform Support
336
337 XXX Any changes to platform support should be listed in the sections below.
338
339 [ Within the sections, list each platform as a =item entry with specific
340 changes as paragraphs below it. ]
341
342 =head2 New Platforms
343
344 XXX List any platforms that this version of perl compiles on, that previous
345 versions did not. These will either be enabled by new files in the F<hints/>
346 directories, or new subdirectories and F<README> files at the top level of the
347 source tree.
348
349 =over 4
350
351 =item XXX-some-platform
352
353 XXX
354
355 =back
356
357 =head2 Discontinued Platforms
358
359 XXX List any platforms that this version of perl no longer compiles on.
360
361 =over 4
362
363 =item XXX-some-platform
364
365 XXX
366
367 =back
368
369 =head2 Platform-Specific Notes
370
371 XXX List any changes for specific platforms. This could include configuration
372 and compilation changes or changes in portability/compatibility.  However,
373 changes within modules for platforms should generally be listed in the
374 L</Modules and Pragmata> section.
375
376 =over 4
377
378 =item XXX-some-platform
379
380 XXX
381
382 =back
383
384 =head1 Internal Changes
385
386 XXX Changes which affect the interface available to C<XS> code go here.
387 Other significant internal changes for future core maintainers should
388 be noted as well.
389
390 [ List each change as a =item entry ]
391
392 =over 4
393
394 =item *
395
396 XXX
397
398 =back
399
400 =head1 Selected Bug Fixes
401
402 XXX Important bug fixes in the core language are summarised here.
403 Bug fixes in files in F<ext/> and F<lib/> are best summarised in
404 L</Modules and Pragmata>.
405
406 [ List each fix as a =item entry ]
407
408 =over 4
409
410 =item *
411
412 Applying the :lvalue attribute to subroutine that is already defined does
413 not work properly, as the attribute changes the way the sub is compiled.
414 Hence, Perl 5.12 began warning when an attempt is made to apply the
415 attribute to an already defined sub.  In such cases, the attribute is
416 discarded.
417
418 But the change in 5.12 missed the case where custom attributes are also
419 present: that case still silently and ineffectively applied the attribute.
420 That omission has now been corrected.  C<sub foo :lvalue :Whatever> (when
421 C<foo> is already defined) now warns about the :lvalue attribute, and does
422 not apply it.
423
424 L<attributes.pm|attributes> has likewise been updated to warn and not apply
425 the attribute.
426
427 =item *
428
429 =for comment
430 Not necessary for perl5160delta
431
432 The remaining discrepancies between explicit and implicit return from
433 lvalue subroutines have been resolved.  They mainly involved which error
434 message to display when a read-only value is returned in lvalue context.
435 Also, returning a PADTMP (the result of most built-ins, like C<index>) in
436 lvalue context is now forbidden for explicit return, as it always has been
437 for implicit return.  This is not a regression from 5.14, as all the cases
438 in which it could happen where previously syntax errors.
439
440 =item *
441
442 =for comment
443 Not necessary for perl5160delta
444
445 Explicitly returning a tied C<my> variable from an lvalue subroutine in
446 list lvalue context used to clear the variable before the assignment could
447 happen.  This is something that was missed when explicit return was made to
448 work in 5.15.0.
449
450 =item *
451
452 =for comment
453 Not necessary for perl5160delta
454
455 A minor memory leak, introduced in 5.15.0, has been fixed.  It would occur
456 when a hash is freed that has had its current iterator deleted
457 [perl #93454].
458
459 =back
460
461 =head1 Known Problems
462
463 XXX Descriptions of platform agnostic bugs we know we can't fix go here. Any
464 tests that had to be C<TODO>ed for the release would be noted here, unless
465 they were specific to a particular platform (see below).
466
467 This is a list of some significant unfixed bugs, which are regressions
468 from either 5.XXX.XXX or 5.XXX.XXX.
469
470 [ List each fix as a =item entry ]
471
472 =over 4
473
474 =item *
475
476 XXX
477
478 =back
479
480 =head1 Obituary
481
482 XXX If any significant core contributor has died, we've added a short obituary
483 here.
484
485 =head1 Acknowledgements
486
487 XXX The list of people to thank goes here.
488
489 =head1 Reporting Bugs
490
491 If you find what you think is a bug, you might check the articles
492 recently posted to the comp.lang.perl.misc newsgroup and the perl
493 bug database at http://rt.perl.org/perlbug/ .  There may also be
494 information at http://www.perl.org/ , the Perl Home Page.
495
496 If you believe you have an unreported bug, please run the L<perlbug>
497 program included with your release.  Be sure to trim your bug down
498 to a tiny but sufficient test case.  Your bug report, along with the
499 output of C<perl -V>, will be sent off to perlbug@perl.org to be
500 analysed by the Perl porting team.
501
502 If the bug you are reporting has security implications, which make it
503 inappropriate to send to a publicly archived mailing list, then please send
504 it to perl5-security-report@perl.org. This points to a closed subscription
505 unarchived mailing list, which includes
506 all the core committers, who will be able
507 to help assess the impact of issues, figure out a resolution, and help
508 co-ordinate the release of patches to mitigate or fix the problem across all
509 platforms on which Perl is supported. Please only use this address for
510 security issues in the Perl core, not for modules independently
511 distributed on CPAN.
512
513 =head1 SEE ALSO
514
515 The F<Changes> file for an explanation of how to view exhaustive details
516 on what changed.
517
518 The F<INSTALL> file for how to build Perl.
519
520 The F<README> file for general stuff.
521
522 The F<Artistic> and F<Copying> files for copyright information.
523
524 =cut