This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Upgrade Socket from 2.002 to 2.003
[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 XXX needs
6 to be processed before release. ]
7
8 perldelta - what is new for perl v5.17.3
9
10 =head1 DESCRIPTION
11
12 This document describes differences between the 5.17.2 release and the 5.17.3
13 release.
14
15 If you are upgrading from an earlier release such as 5.17.1, first read
16 L<perl5172delta>, which describes differences between 5.17.1 and 5.17.2.
17
18 =head1 Notice
19
20 XXX Any important notices here
21
22 =head1 Core Enhancements
23
24 XXX New core language features go here.  Summarize user-visible core language
25 enhancements.  Particularly prominent performance optimisations could go
26 here, but most should go in the L</Performance Enhancements> section.
27
28 [ List each enhancement as a =head2 entry ]
29
30 =head2 Computed Labels
31
32 The loop controls C<next>, C<last> and C<redo>, and the special C<dump>
33 operator, now allow arbitrary expressions to be used to compute labels at
34 run time.  Previously, any argument that was not a constant was treated as
35 the empty string.
36
37 =head1 Security
38
39 XXX Any security-related notices go here.  In particular, any security
40 vulnerabilities closed should be noted here rather than in the
41 L</Selected Bug Fixes> section.
42
43 [ List each security issue as a =head2 entry ]
44
45 =head1 Incompatible Changes
46
47 [ List each incompatible change as a =head2 entry ]
48
49 =head2 C<$ENV{foo}=undef> deletes value from environ, like C<delete $ENV{foo}>
50
51 This facilitates use of C<local()> with C<%ENV> entries.  In previous
52 versions of Perl, C<undef> was converted to the empty string.
53
54 =head2 Defined values stored in environment are forced to byte strings
55
56 A value stored in an environment variable has always been stringified.  In
57 this release, it is converted to be only a byte string.  First, it is forced
58 to be a only a string.  Then if the string is utf8 and the equivalent of
59 C<utf8::downgrade()> works, that result is used; otherwise, the equivalent of
60 C<utf8::encode()> is used, and a warning is issued about wide characters
61 (L</Diagnostics>).
62
63 =head2 C<given> now aliases the global C<$_>
64
65 Instead of assigning to an implicit lexical C<$_>, C<given> now makes the
66 global C<$_> an alias for its argument, just like C<foreach>.  However, it
67 still uses lexical C<$_> if there is lexical C<$_> in scope (again, just like
68 C<foreach>).
69
70 =head1 Deprecations
71
72 XXX Any deprecated features, syntax, modules etc. should be listed here.  In
73 particular, deprecated modules should be listed here even if they are listed as
74 an updated module in the L</Modules and Pragmata> section.
75
76 [ List each deprecation as a =head2 entry ]
77
78 =head1 Performance Enhancements
79
80 XXX Changes which enhance performance without changing behaviour go here.
81 There may well be none in a stable release.
82
83 [ List each enhancement as a =item entry ]
84
85 =over 4
86
87 =item *
88
89 XXX
90
91 =back
92
93 =head1 Modules and Pragmata
94
95 XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
96 go here.  If Module::CoreList is updated, generate an initial draft of the
97 following sections using F<Porting/corelist-perldelta.pl>, which prints stub
98 entries to STDOUT.  Results can be pasted in place of the '=head2' entries
99 below.  A paragraph summary for important changes should then be added by hand.
100 In an ideal world, dual-life modules would have a F<Changes> file that could be
101 cribbed.
102
103 [ Within each section, list entries as a =item entry ]
104
105 =head2 New Modules and Pragmata
106
107 =over 4
108
109 =item *
110
111 XXX
112
113 =back
114
115 =head2 Updated Modules and Pragmata
116
117 =over 4
118
119 =item *
120
121 L<B> has been upgraded from version 1.36 to 1.37.  All C<CVf_*> and C<GVf_*>
122 and more SV-related flag values are now provided as constants in the C<B::>
123 namespace and available for export.  The default export list has not changed.
124
125 =item *
126
127 L<B::Concise> has been upgraded from version 0.91 to 0.92.  The C<-nobanner>
128 option has been fixed, and C<format>s can now be dumped.  When passed a sub
129 name to dump, it will check also to see whether it is the name of a format.  If
130 a sub and a format share the same name, it will dump both.
131
132 =item *
133
134 L<B::Deparse> has been upgraded from version 1.15 to 1.16.  It now deparses
135 loop controls with the correct precedence, and multiple statements in a
136 C<format> line are also now deparsed correctly.
137
138 =item *
139
140 L<Compress::Raw::Bzip2> has been upgraded from version 2.05201 to 2.055.  The
141 misuse of Perl's "magic" API has been fixed.
142
143 =item *
144
145 L<Compress::Raw::Zlib> has been upgraded from version 2.05401 to 2.056.  The
146 misuse of Perl's "magic" API has been fixed.
147
148 =item *
149
150 L<Compress::Zlib> has been upgraded from version 2.052 to 2.055.
151 C<compress()>, C<uncompress()>, C<memGzip()> and C<memGunzip()> have been
152 speeded up by making parameter validation more efficient.
153
154 =item *
155
156 L<Data::Dumper> has been upgraded from version 2.135_06 to 2.135_07.  It has
157 been optimized to only build a seen-scalar hash as necessary, thereby speeding
158 up serialization drastically.
159
160 =item *
161
162 L<Devel::Peek> has been upgraded from version 1.08 to 1.09.  The only change
163 has been to the test script, to account for changes to some flags in perl's
164 internals.
165
166 =item *
167
168 L<Encode> has been upgraded from version 2.44 to 2.47.  The Mac alias x-mac-ce
169 has been added, and various bugs have been fixed in Encode::Unicode,
170 Encode::UTF7 and Encode::GSM0338.
171
172 =item *
173
174 L<Module::Build> has been upgraded from version 0.40 to 0.4002.  A minor bug
175 fix allows markup to be used around the leading "Name" in a POD "abstract"
176 line, and some documentation improvements have been made.
177
178 =item *
179
180 L<Module::CoreList> has been upgraded from version 2.69 to 2.70.  Version
181 information is now stored as a delta, which greatly reduces the size of the
182 F<CoreList.pm> file.
183
184 =item *
185
186 L<Module::Load::Conditional> has been upgraded from version 0.50 to 0.54.
187 Various enhancements include the new use of Module::Metadata.
188
189 =item *
190
191 L<Module::Metadata> has been upgraded from version 1.000009 to 1.000010.  The
192 creation of a Module::Metadata object for a typical module file has been sped
193 up by about 40%.
194
195 =item *
196
197 L<Module::Pluggable> has been upgraded from version 4.0 to 4.2.  Amongst other
198 changes, triggers are now allowed on events, which gives a powerful way to
199 modify behaviour.
200
201 =item *
202
203 L<Pod::Simple> has been upgraded from version 3.20 to 3.23.  Numerous
204 improvements have been made, mostly to Pod::Simple::XHTML, which also has a
205 compatibility change: the C<codes_in_verbatim> option is now disabled by
206 default.  See F<cpan/Pod-Simple/ChangeLog> for the full details.
207
208 =item *
209
210 L<re> has been upgraded from version 0.21 to 0.22.  Single character [class]es
211 like C</[s]/> or C</[s]/i> are now optimized as if they did not have the
212 brackets, i.e. C</s/> or C</s/i>.
213
214 =item *
215
216 L<Socket> has been upgraded from version 2.002 to 2.003.  Constants and
217 functions required for IP multicast source group membership have been added.
218
219 =item *
220
221 L<Storable> has been upgraded from version 2.37 to 2.38.  It can now freeze
222 and thaw vstrings correctly.  This causes a slight incompatible change in
223 the storage format, so the format version has increased to 2.9.
224
225 =item *
226
227 L<Sys::Syslog> has been upgraded from version 0.29 to 0.30.  An issue with
228 C<POSIX::strftime()> on Windows and a build problem on Haiku-OS have been
229 resolved, and <getservbyname()> is no longer called when the port is specified.
230
231 =item *
232
233 L<Time::Local> has been upgraded from version 1.2000 to 1.2300.  Seconds values
234 greater than 59 but less than 60 no longer cause C<timegm()> and C<timelocal()>
235 to croak.
236
237 =item *
238
239 L<Unicode::UCD> has been upgraded from version 0.44 to 0.45.  This has been
240 modified slightly for reasons of perl internal use only.
241
242 =item *
243
244 L<Win32> has been upgraded from version 0.44 to 0.45.  New APIs have been added
245 for getting and setting the current code page.
246
247 =item *
248
249 L<Win32CORE> has been upgraded from version 0.02 to 0.03.  The use of
250 PERL_NO_GET_CONTEXT here has resulted in smaller machine code.
251
252 =back
253
254 =head1 Documentation
255
256 XXX Changes to files in F<pod/> go here.  Consider grouping entries by file and
257 be sure to link to the appropriate page, e.g. L<perlfunc>.
258
259 =head2 New Documentation
260
261 XXX Changes which create B<new> files in F<pod/> go here.
262
263 =head3 L<XXX>
264
265 XXX Description of the purpose of the new file here
266
267 =head2 Changes to Existing Documentation
268
269 XXX Changes which significantly change existing files in F<pod/> go here.
270 However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
271 section.
272
273 =head3 L<perlfunc>, L<perlop>
274
275 =over 4
276
277 =item *
278
279 Loop control verbs (C<dump>, C<goto>, C<next>, C<last> and C<redo>) have
280 always had the same precedence as assignment operators, but this was never
281 documented until now.
282
283 =back
284
285 =head1 Diagnostics
286
287 The following additions or changes have been made to diagnostic output,
288 including warnings and fatal error messages.  For the complete list of
289 diagnostic messages, see L<perldiag>.
290
291 XXX New or changed warnings emitted by the core's C<C> code go here.  Also
292 include any changes in L<perldiag> that reconcile it to the C<C> code.
293
294 =head2 New Diagnostics
295
296 XXX Newly added diagnostic messages go under here, separated into New Errors
297 and New Warnings
298
299 =head3 New Errors
300
301 =over 4
302
303 =item *
304
305 L<Unterminated delimiter for here document|perldiag/"Unterminated delimiter for here document">
306
307 This message now occurs when a here document label has an initial quotation
308 mark but the final quotation mark is missing.
309
310 This replaces a bogus and misleading error message about not finding the
311 label itself [perl #114104].
312
313 =back
314
315 =head3 New Warnings
316
317 =over 4
318
319 =item *
320
321 L<Wide character in setenv|perldiag/"Wide character in %s">
322
323 Attempts to put wide characters into environment variables via C<%ENV> now
324 provoke this warning.
325
326 =back
327
328 =head2 Changes to Existing Diagnostics
329
330 XXX Changes (i.e. rewording) of diagnostic messages go here
331
332 =over 4
333
334 =item *
335
336 XXX Describe change here
337
338 =back
339
340 =head1 Utility Changes
341
342 XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here.
343 Most of these are built within the directories F<utils> and F<x2p>.
344
345 [ List utility changes as a =head3 entry for each utility and =item
346 entries for each change
347 Use L<XXX> with program names to get proper documentation linking. ]
348
349 =head3 L<XXX>
350
351 =over 4
352
353 =item *
354
355 XXX
356
357 =back
358
359 =head1 Configuration and Compilation
360
361 XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
362 go here.  Any other changes to the Perl build process should be listed here.
363 However, any platform-specific changes should be listed in the
364 L</Platform Support> section, instead.
365
366 [ List changes as a =item entry ].
367
368 =over 4
369
370 =item *
371
372 XXX
373
374 =back
375
376 =head1 Testing
377
378 XXX Any significant changes to the testing of a freshly built perl should be
379 listed here.  Changes which create B<new> files in F<t/> go here as do any
380 large changes to the testing harness (e.g. when parallel testing was added).
381 Changes to existing files in F<t/> aren't worth summarizing, although the bugs
382 that they represent may be covered elsewhere.
383
384 [ List each test improvement as a =item entry ]
385
386 =over 4
387
388 =item *
389
390 XXX
391
392 =back
393
394 =head1 Platform Support
395
396 XXX Any changes to platform support should be listed in the sections below.
397
398 [ Within the sections, list each platform as a =item entry with specific
399 changes as paragraphs below it. ]
400
401 =head2 New Platforms
402
403 XXX List any platforms that this version of perl compiles on, that previous
404 versions did not . These will either be enabled by new files in the F<hints/>
405 directories, or new subdirectories and F<README> files at the top level of the
406 source tree.
407
408 =over 4
409
410 =item XXX-some-platform
411
412 XXX
413
414 =back
415
416 =head2 Discontinued Platforms
417
418 XXX List any platforms that this version of perl no longer compiles on.
419
420 =over 4
421
422 =item XXX-some-platform
423
424 XXX
425
426 =back
427
428 =head2 Platform-Specific Notes
429
430 XXX List any changes for specific platforms.  This could include configuration
431 and compilation changes or changes in portability/compatibility.  However,
432 changes within modules for platforms should generally be listed in the
433 L</Modules and Pragmata> section.
434
435 =over 4
436
437 =item XXX-some-platform
438
439 XXX
440
441 =back
442
443 =head1 Internal Changes
444
445 XXX Changes which affect the interface available to C<XS> code go here.  Other
446 significant internal changes for future core maintainers should be noted as
447 well.
448
449 [ List each change as a =item entry ]
450
451 =over 4
452
453 =item *
454
455 XXX
456
457 =back
458
459 =head1 Selected Bug Fixes
460
461 XXX Important bug fixes in the core language are summarized here.  Bug fixes in
462 files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>.
463
464 [ List each fix as a =item entry ]
465
466 =over 4
467
468 =item *
469
470 C<\w> now matches the code points U+200C (ZERO WIDTH NON-JOINER) and
471 U+200D (ZERO WIDTH JOINER).  C<\W> no longer matches these.  This change
472 is because Unicode corrected their definition of what C<\w> should match.
473
474 =item *
475
476 C<dump LABEL> no longer leaks its label.
477
478 =item *
479
480 Constant folding no longer changes the behaviour of functions like C<stat()>
481 and C<truncate()> that can take either filenames or handles.
482 C<stat 1 ? foo : bar> nows treats its argument as a file name (since it is
483 an arbitrary expression), rather than the handle "foo".
484
485 =item *
486
487 C<truncate FOO, $len> no longer falls back to treating "FOO" as a file name
488 if the filehandle has been deleted.  This was broken in Perl 5.16.0.
489
490 =item *
491
492 Subroutine redefinitions after sub-to-glob and glob-to-glob assignments no
493 longer cause double frees or panic messages.
494
495 =item *
496
497 C<s///> now turns vstrings into plain strings when performing a
498 substitution, even if the resulting string is the same (C<s/a/a/>).
499
500 =item *
501
502 Prototype mismatch warnings no longer erroneously treat constant subs as
503 having no prototype when they actually have "".
504
505 =item *
506
507 Constant subroutines and forward declarations no longer prevent prototype
508 mismatch warnings from omitting the sub name.
509
510 =item *
511
512 C<undef> on a subroutine now clears call checkers.
513
514 =item *
515
516 The C<ref> operator started leaking memory on blessed objects in Perl
517 5.16.0.  This has been fixed [perl #114340].
518
519 =item *
520
521 C<use> no longer tries to parse its arguments as a statement, making
522 C<use constant { () };> a syntax error [perl #114222].
523
524 =item *
525
526 On debugging builds, "uninitialized" warnings inside formats no longer
527 cause assertion failures.
528
529 =item *
530
531 On debugging builds, subroutines nested inside formats no longer cause
532 assertion failures [perl #78550].
533
534 =item *
535
536 C<print $x> and C<sub { print $x }->()> now always produce the same output.
537 It was possible for the latter to refuse to close over $x if the variable
538 was not active; e.g., if it was defined outside a currently-running named
539 subroutine.
540
541 =item *
542
543 Similarly, C<print $x> and C<print eval '$x'> now produce the same output.
544 This also allows "my $x if 0" variables to be seen in the debugger
545 [perl #114018].
546
547 =item *
548
549 Formats called recursively no longer stomp on their own lexical variables,
550 but each recursive call has its own set of lexicals.
551
552 =item *
553
554 Attempting to free an active format or the handle associated with it no
555 longer results in a crash.
556
557 =item *
558
559 Format parsing no longer gets confused by braces, semicolons and
560 low-precedence operators.  It used to be possible to use braces as format
561 delimiters (instead of C<=> and C<.>), but only sometimes.  Semicolons and
562 low-precedence operators in format argument lines no longer confuse the
563 parser into ignoring the line's return value.  In format argument lines,
564 braces can now be used for anonymous hashes, instead of being treated
565 always as C<do> blocks.
566
567 =item *
568
569 Formats can now be nested inside code blocks in regular expressions and
570 other quoted constructs (C</(?{...})/> and C<qq/${...}/>) [perl #114040].
571
572 =item *
573
574 Formats are no longer created after compilation errors.
575
576 =back
577
578 =head1 Known Problems
579
580 XXX Descriptions of platform agnostic bugs we know we can't fix go here.  Any
581 tests that had to be C<TODO>ed for the release would be noted here.  Unfixed
582 platform specific bugs also go here.
583
584 [ List each fix as a =item entry ]
585
586 =over 4
587
588 =item *
589
590 XXX
591
592 =back
593
594 =head1 Obituary
595
596 XXX If any significant core contributor has died, we've added a short obituary
597 here.
598
599 =head1 Acknowledgements
600
601 XXX Generate this with:
602
603   perl Porting/acknowledgements.pl v5.17.2..HEAD
604
605 =head1 Reporting Bugs
606
607 If you find what you think is a bug, you might check the articles recently
608 posted to the comp.lang.perl.misc newsgroup and the perl bug database at
609 http://rt.perl.org/perlbug/ .  There may also be information at
610 http://www.perl.org/ , the Perl Home Page.
611
612 If you believe you have an unreported bug, please run the L<perlbug> program
613 included with your release.  Be sure to trim your bug down to a tiny but
614 sufficient test case.  Your bug report, along with the output of C<perl -V>,
615 will be sent off to perlbug@perl.org to be analysed by the Perl porting team.
616
617 If the bug you are reporting has security implications, which make it
618 inappropriate to send to a publicly archived mailing list, then please send it
619 to perl5-security-report@perl.org.  This points to a closed subscription
620 unarchived mailing list, which includes all the core committers, who will be
621 able to help assess the impact of issues, figure out a resolution, and help
622 co-ordinate the release of patches to mitigate or fix the problem across all
623 platforms on which Perl is supported.  Please only use this address for
624 security issues in the Perl core, not for modules independently distributed on
625 CPAN.
626
627 =head1 SEE ALSO
628
629 The F<Changes> file for an explanation of how to view exhaustive details on
630 what changed.
631
632 The F<INSTALL> file for how to build Perl.
633
634 The F<README> file for general stuff.
635
636 The F<Artistic> and F<Copying> files for copyright information.
637
638 =cut