perldelta: hash function still needs mention
[perl.git] / pod / perldelta.pod
1 =encoding utf8
2
3 =for todo
4 284167a smueller Add C define to remove taint support from perl
5 ba593ad davem    clone() wasn't cloning the whole stack
6 7dc8663 demerphq Hash Function Change - Murmur hash and true per process...
7
8 =head1 NAME
9
10 [ this is a template for a new perldelta file.  Any text flagged as XXX needs
11 to be processed before release. ]
12
13 perldelta - what is new for perl v5.17.6
14
15 =head1 DESCRIPTION
16
17 This document describes differences between the 5.17.5 release and the 5.17.6
18 release.
19
20 If you are upgrading from an earlier release such as 5.17.4, first read
21 L<perl5175delta>, which describes differences between 5.17.4 and 5.17.5.
22
23 =head1 Notice
24
25 XXX Any important notices here
26
27 =head1 Core Enhancements
28
29 XXX New core language features go here.  Summarize user-visible core language
30 enhancements.  Particularly prominent performance optimisations could go
31 here, but most should go in the L</Performance Enhancements> section.
32
33 [ List each enhancement as a =head2 entry ]
34
35 =head2 Character name aliases may now include non-Latin1-range characters
36
37 It is possible to define your own names for characters for use in
38 C<\N{...}>, C<charnames::vianame()>, etc.  These names can now be
39 comprised of characters from the whole Unicode range.  This allows for
40 names to be in your native language, and not just English.  Certain
41 restrictions apply to the characters that may be used (you can't define
42 a name that has punctuation in it, for example).  See L<charnames/CUSTOM
43 ALIASES>.
44
45 =head1 Security
46
47 XXX Any security-related notices go here.  In particular, any security
48 vulnerabilities closed should be noted here rather than in the
49 L</Selected Bug Fixes> section.
50
51 [ List each security issue as a =head2 entry ]
52
53 =head1 Incompatible Changes
54
55 XXX For a release on a stable branch, this section aspires to be:
56
57     There are no changes intentionally incompatible with 5.XXX.XXX
58     If any exist, they are bugs, and we request that you submit a
59     report.  See L</Reporting Bugs> below.
60
61 [ List each incompatible change as a =head2 entry ]
62
63 =head2 An unknown character name in C<\N{...}> is now a syntax error
64
65 Previously, it warned, and the Unicode REPLACEMENT CHARACTER was
66 substituted.  Unicode now recommends that this situation be a syntax
67 error.  Also, the previous behavior led to some confusing warnings and
68 behaviors, and since the REPLACEMENT CHARACTER has no use other than as
69 a stand-in for some unknown character, any code that has this problem is
70 buggy.
71
72 =head2 Formerly deprecated characters in C<\N{}> character name aliases are now errors.
73
74 Since v5.12.0, it has been deprecated to use certain characters in
75 user-defined C<\N{...}> character names.  These now cause a syntax
76 error.  For example, it is now an error to begin a name with a digit,
77 such as in
78
79  my $undraftable = "\N{4F}";    # Syntax error!
80
81 or to have commas anywhere in the name.  See L<charnames/CUSTOM ALIASES>
82
83 =head1 Deprecations
84
85 XXX Any deprecated features, syntax, modules etc. should be listed here.  In
86 particular, deprecated modules should be listed here even if they are listed as
87 an updated module in the L</Modules and Pragmata> section.
88
89 [ List each deprecation as a =head2 entry ]
90
91 =head1 Performance Enhancements
92
93 XXX Changes which enhance performance without changing behaviour go here.
94 There may well be none in a stable release.
95
96 [ List each enhancement as a =item entry ]
97
98 =over 4
99
100 =item *
101
102 Lists of lexical variable declarations (C<my($x, $y)>) are now optimised
103 down to a single op, and are hence faster than before.
104
105 =back
106
107 =head1 Modules and Pragmata
108
109 XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
110 go here.  If Module::CoreList is updated, generate an initial draft of the
111 following sections using F<Porting/corelist-perldelta.pl>, which prints stub
112 entries to STDOUT.  Results can be pasted in place of the '=head2' entries
113 below.  A paragraph summary for important changes should then be added by hand.
114 In an ideal world, dual-life modules would have a F<Changes> file that could be
115 cribbed.
116
117 [ Within each section, list entries as a =item entry ]
118
119 =head2 New Modules and Pragmata
120
121 =over 4
122
123 =item *
124
125 XXX
126
127 =back
128
129 =head2 Updated Modules and Pragmata
130
131 =over 4
132
133 =item *
134
135 L<Carp> has been upgraded from version 1.27 to 1.28.
136
137 Carp is no longer confused when C<caller> returns undef for a package that
138 has been deleted.
139
140 =item *
141
142 L<CPAN> has been upgraded from version 1.98 to 1.99_51.
143
144 =item *
145
146 L<DynaLoader> has been upgraded from version 1.16 to 1.17.
147
148 =item *
149
150 L<Env> has been upgraded from version 1.03 to 1.04.
151
152 Its SPLICE implementation no longer misbehaves in list context.
153
154 =item *
155
156 L<Tie::Hash::NamedCapture> has been upgraded from version 0.08 to 0.09.
157
158 =back
159
160 =head2 Removed Modules and Pragmata
161
162 =over 4
163
164 =item *
165
166 XXX
167
168 =back
169
170 =head1 Documentation
171
172 XXX Changes to files in F<pod/> go here.  Consider grouping entries by
173 file and be sure to link to the appropriate page, e.g. L<perlfunc>.
174
175 =head2 New Documentation
176
177 XXX Changes which create B<new> files in F<pod/> go here.
178
179 =head3 L<XXX>
180
181 XXX Description of the purpose of the new file here
182
183 =head2 Changes to Existing Documentation
184
185 XXX Changes which significantly change existing files in F<pod/> go here.
186 However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
187 section.
188
189 =head3 L<perlref>
190
191 =over 4
192
193 =item *
194
195 C<*foo{NAME}> and C<*foo{PACKAGE}>, which have existed since perl 5.005,
196 are now documented.
197
198 =back
199
200 =head1 Diagnostics
201
202 The following additions or changes have been made to diagnostic output,
203 including warnings and fatal error messages.  For the complete list of
204 diagnostic messages, see L<perldiag>.
205
206 XXX New or changed warnings emitted by the core's C<C> code go here.  Also
207 include any changes in L<perldiag> that reconcile it to the C<C> code.
208
209 =head2 New Diagnostics
210
211 XXX Newly added diagnostic messages go under here, separated into New Errors
212 and New Warnings
213
214 =head3 New Errors
215
216 =over 4
217
218 =item *
219
220 XXX L<message|perldiag/"message">
221
222 =back
223
224 =head3 New Warnings
225
226 =over 4
227
228 =item *
229
230 XXX L<message|perldiag/"message">
231
232 =back
233
234 =head2 Changes to Existing Diagnostics
235
236 XXX Changes (i.e. rewording) of diagnostic messages go here
237
238 =over 4
239
240 =item *
241
242 XXX Describe change here
243
244 =back
245
246 =head1 Utility Changes
247
248 XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here.
249 Most of these are built within the directories F<utils> and F<x2p>.
250
251 [ List utility changes as a =head3 entry for each utility and =item
252 entries for each change
253 Use L<XXX> with program names to get proper documentation linking. ]
254
255 =head3 L<XXX>
256
257 =over 4
258
259 =item *
260
261 XXX
262
263 =back
264
265 =head1 Configuration and Compilation
266
267 XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
268 go here.  Any other changes to the Perl build process should be listed here.
269 However, any platform-specific changes should be listed in the
270 L</Platform Support> section, instead.
271
272 [ List changes as a =item entry ].
273
274 =over 4
275
276 =item *
277
278 XXX
279
280 =back
281
282 =head1 Testing
283
284 XXX Any significant changes to the testing of a freshly built perl should be
285 listed here.  Changes which create B<new> files in F<t/> go here as do any
286 large changes to the testing harness (e.g. when parallel testing was added).
287 Changes to existing files in F<t/> aren't worth summarizing, although the bugs
288 that they represent may be covered elsewhere.
289
290 [ List each test improvement as a =item entry ]
291
292 =over 4
293
294 =item *
295
296 XXX
297
298 =back
299
300 =head1 Platform Support
301
302 XXX Any changes to platform support should be listed in the sections below.
303
304 [ Within the sections, list each platform as a =item entry with specific
305 changes as paragraphs below it. ]
306
307 =head2 New Platforms
308
309 XXX List any platforms that this version of perl compiles on, that previous
310 versions did not.  These will either be enabled by new files in the F<hints/>
311 directories, or new subdirectories and F<README> files at the top level of the
312 source tree.
313
314 =over 4
315
316 =item XXX-some-platform
317
318 XXX
319
320 =back
321
322 =head2 Discontinued Platforms
323
324 XXX List any platforms that this version of perl no longer compiles on.
325
326 =over 4
327
328 =item XXX-some-platform
329
330 XXX
331
332 =back
333
334 =head2 Platform-Specific Notes
335
336 XXX List any changes for specific platforms.  This could include configuration
337 and compilation changes or changes in portability/compatibility.  However,
338 changes within modules for platforms should generally be listed in the
339 L</Modules and Pragmata> section.
340
341 =over 4
342
343 =item XXX-some-platform
344
345 XXX
346
347 =back
348
349 =head1 Internal Changes
350
351 XXX Changes which affect the interface available to C<XS> code go here.  Other
352 significant internal changes for future core maintainers should be noted as
353 well.
354
355 [ List each change as a =item entry ]
356
357 =over 4
358
359 =item *
360
361 The private Perl_croak_no_modify has had its context parameter removed. It is
362 now has a void prototype. Users of the public API croak_no_modify remain
363 unaffected.
364
365 =item *
366
367 Copy-on-write (shared hash key) scalars are no longer marked read-only.
368 C<SvREADONLY> returns false on such an SV, but C<SvIsCOW> still returns
369 true.
370
371 =back
372
373 =head1 Selected Bug Fixes
374
375 XXX Important bug fixes in the core language are summarized here.  Bug fixes in
376 files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>.
377
378 [ List each fix as a =item entry ]
379
380 =over 4
381
382 =item *
383
384 Uninitialized warnings mentioning hash elements would only mention the
385 element name if it was not in the first bucket of the hash, due to an
386 off-by-one error.
387
388 =item *
389
390 A regular expression optimizer bug could cause multiline "^" to behave
391 incorrectly in the presence of line breaks, such that
392 C<"/\n\n" =~ m#\A(?:^/$)#im> would not match [perl #115242].
393
394 =item *
395
396 Failed C<fork> in list context no longer currupts the stack.
397 C<@a = (1, 2, fork, 3)> used to gobble up the 2 and assign C<(1, undef, 3)>
398 if the C<fork> call failed.
399
400 =item *
401
402 Numerous memory leaks have been fixed, mostly involving tied variables that
403 die, regular expression character classes and code blocks, and syntax
404 errors.
405
406 =item *
407
408 Assigning a regular expression (C<${qr//}>) to a variable that happens to
409 hold a floating point number no longer causes assertion failures on
410 debugging builds.
411
412 =item *
413
414 Assigning a regular expression to a scalar containing a number no longer
415 causes subsequent nummification to produce random numbers.
416
417 =item *
418
419 Assigning a regular expression to a magic variable no longer wipes away the
420 magic.  This is a regression from 5.10.
421
422 =item *
423
424 Assigning a regular expression to a blessed scalar no longer results in
425 crashes.  This is also a regression from 5.10.
426
427 =item *
428
429 Regular expression can now be assigned to tied hash and array elements with
430 flattening into strings.
431
432 =item *
433
434 Nummifying a regular expression no longer results in an uninitialized
435 warning.
436
437 =item *
438
439 Negative array indices no longer cause EXISTS methods of tied variables to
440 be ignored.  This is a regression from 5.12.
441
442 =item *
443
444 Negative array indices no longer result in crashes on arrays tied to
445 non-objects.
446
447 =item *
448
449 C<$x = "(?{})"; /a++(?{})+$x/x> no longer erroneous produces an error (just
450 a warning, as expected).  This was broken in 5.17.1.
451
452 =item *
453
454 C<$byte_overload .= $utf8> no longer results in doubly-encoded UTF8 if the
455 left-hand scalar happened to have produced a UTF8 string the last time
456 overloading was invoked.
457
458 =item *
459
460 C<goto &sub> now uses the current value of @_, instead of using the array
461 the subroutine was originally called with.  This means
462 C<local @_ = (...); goto &sub> now works [perl #43077].
463
464 =item *
465
466 If a debugger is invoked recursively, it no longer stomps on its own
467 lexical variables.  Formerly under recursion all calls would share the same
468 set of lexical variables [perl #115742].
469
470 =item *
471
472 C<*_{ARRAY}> returned from a subroutine no longer spontaneously
473 becomes empty.
474
475 =back
476
477 =head1 Known Problems
478
479 XXX Descriptions of platform agnostic bugs we know we can't fix go here.  Any
480 tests that had to be C<TODO>ed for the release would be noted here.  Unfixed
481 platform specific bugs also go here.
482
483 [ List each fix as a =item entry ]
484
485 =over 4
486
487 =item *
488
489 XXX
490
491 =back
492
493 =head1 Obituary
494
495 XXX If any significant core contributor has died, we've added a short obituary
496 here.
497
498 =head1 Acknowledgements
499
500 XXX Generate this with:
501
502   perl Porting/acknowledgements.pl v5.17.5..HEAD
503
504 =head1 Reporting Bugs
505
506 If you find what you think is a bug, you might check the articles recently
507 posted to the comp.lang.perl.misc newsgroup and the perl bug database at
508 http://rt.perl.org/perlbug/ .  There may also be information at
509 http://www.perl.org/ , the Perl Home Page.
510
511 If you believe you have an unreported bug, please run the L<perlbug> program
512 included with your release.  Be sure to trim your bug down to a tiny but
513 sufficient test case.  Your bug report, along with the output of C<perl -V>,
514 will be sent off to perlbug@perl.org to be analysed by the Perl porting team.
515
516 If the bug you are reporting has security implications, which make it
517 inappropriate to send to a publicly archived mailing list, then please send it
518 to perl5-security-report@perl.org.  This points to a closed subscription
519 unarchived mailing list, which includes all the core committers, who will be
520 able to help assess the impact of issues, figure out a resolution, and help
521 co-ordinate the release of patches to mitigate or fix the problem across all
522 platforms on which Perl is supported.  Please only use this address for
523 security issues in the Perl core, not for modules independently distributed on
524 CPAN.
525
526 =head1 SEE ALSO
527
528 The F<Changes> file for an explanation of how to view exhaustive details on
529 what changed.
530
531 The F<INSTALL> file for how to build Perl.
532
533 The F<README> file for general stuff.
534
535 The F<Artistic> and F<Copying> files for copyright information.
536
537 =cut