This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Add the generated Acknowledgements section to perldelta
[perl5.git] / pod / perldelta.pod
1 =encoding utf8
2
3 =for to-do
4 23b7025ebc definitely needs to be summarised.
5
6 =head1 NAME
7
8 perldelta - what is new for perl v5.17.7
9
10 =head1 DESCRIPTION
11
12 This document describes differences between the 5.17.6 release and the 5.17.7
13 release.
14
15 If you are upgrading from an earlier release such as 5.17.5, first read
16 L<perl5176delta>, which describes differences between 5.17.5 and 5.17.6.
17
18 =head1 Core Enhancements
19
20 =head2 $&, $` and $' are no longer slow
21
22 These three infamous variables have been redeemed and no longer slow down
23 your program when used.  Hence, the /p regular expression flag now does
24 nothing.
25
26 =head1 Security
27
28 =head1 Incompatible Changes
29
30 =head2 readline() with C<$/ = \N> now reads N characters, not N bytes
31
32 Previously, when reading from a stream with I/O layers such as
33 C<encoding>, the readline() function, otherwise known as the C<< <> >>
34 operator, would read I<N> bytes from the top-most layer. [perl #79960]
35
36 Now, I<N> characters are read instead.
37
38 There is no change in behaviour when reading from streams with no
39 extra layers, since bytes map exactly to characters.
40
41 =head2 Lexical subroutine warnings have moved
42
43 The warning about the use of an experimental feature emitted when lexical
44 subroutines (added in 5.17.4) are used now happens when the subroutine
45 itself is declared, not when the "lexical_subs" feature is activated via
46 C<use feature>.
47
48 This stops C<use feature ':all'> from warning, but causes
49 C<my sub foo; my sub bar> to warn twice.
50
51 =head2 Overridden C<glob> is now passed one argument
52
53 C<glob> overrides used to be passed a magical undocumented second argument
54 that identified the caller.  Nothing on CPAN was using this, and it got in
55 the way of a bug fix, so it was removed.  If you really need to identify
56 the caller, see L<Devel::Callsite> on CPAN.
57
58 =head1 Deprecations
59
60 =head2 Lexical $_ is now deprecated
61
62 Since it was introduced in Perl 5.10, it has caused much confusion with no
63 obvious solution:
64
65 =over
66
67 =item *
68
69 Various modules (e.g., List::Util) expect callback routines to use the
70 global $_.  C<use List::Util 'first'; my $_; first { $_ == 1 } @list> does
71 not work as one would expect.
72
73 =item *
74
75 A C<my $_> declaration earlier in the same file can cause confusing closure
76 warnings.
77
78 =item *
79
80 The "_" subroutine prototype character allows called subroutines to access
81 your lexical $_, so it is not really private after all.
82
83 =item *
84
85 Nevertheless, subroutines with a "(@)" prototype and methods cannot access
86 the caller's lexical $_, unless they are written in XS.
87
88 =item *
89
90 But even XS routines cannot access a lexical $_ declared, not in the
91 calling subroutine, but in an outer scope, iff that subroutine happened not
92 to mention $_ or use any operators that default to $_.
93
94 =back
95
96 =head2 Various XS-callable functions are now deprecated
97
98 The following functions will be removed from a future version of Perl,
99 and should not be used.  With participating C compilers (e.g., gcc),
100 compiling any file that uses any of these will generate a warning.
101 These were not intended for public use; there are equivalent, faster,
102 macros for most of them.  See L<perlapi/Character classes>:
103 C<is_uni_ascii>,
104 C<is_uni_ascii_lc>,
105 C<is_uni_blank>,
106 C<is_uni_blank_lc>,
107 C<is_uni_cntrl>,
108 C<is_uni_cntrl_lc>,
109 C<is_uni_idfirst_lc>,
110 C<is_uni_space>,
111 C<is_uni_space_lc>,
112 C<is_uni_xdigit>,
113 C<is_uni_xdigit_lc>,
114 C<is_utf8_ascii>,
115 C<is_utf8_blank>,
116 C<is_utf8_cntrl>,
117 C<is_utf8_idcont>,
118 C<is_utf8_idfirst>,
119 C<is_utf8_perl_space>,
120 C<is_utf8_perl_word>,
121 C<is_utf8_posix_digit>,
122 C<is_utf8_space>,
123 C<is_utf8_xdigit>.
124 C<is_utf8_xidcont>,
125 C<is_utf8_xidfirst>,
126 C<to_uni_lower_lc>,
127 C<to_uni_title_lc>,
128 and
129 C<to_uni_upper_lc>.
130
131 =head1 Performance Enhancements
132
133 =over 4
134
135 =item *
136
137 Perl has a new copy-on-write mechanism that avoids the need to copy the
138 internal string buffer when assigning from one scalar to another.  This
139 makes copying large strings appear much faster.  Modifying one of the two
140 (or more) strings after an assignment will force a copy internally.  This
141 makes it unnecessary to pass strings by reference for efficiency.
142
143 =back
144
145 =head1 Modules and Pragmata
146
147 =head2 Updated Modules and Pragmata
148
149 =over 4
150
151 =item *
152
153 L<File::DosGlob> has been upgraded from version 1.08 to 1.09.  The internal
154 cache of file names that it keeps for each caller is now freed when that
155 caller is freed.  This means
156 C<< use File::DosGlob 'glob'; eval 'scalar <*>' >> no longer leaks memory.
157
158 =item *
159
160 L<File::Glob> has been upgraded from version 1.18 to 1.19.  File::Glob has
161 had exactly the same fix as File::DosGlob.  Since it is what Perl's own
162 C<glob> operator itself uses (except on VMS), this means
163 C<< eval 'scalar <*>' >> no longer leaks.
164
165 =item *
166
167 L<GDBM_File> has been upgraded from version 1.14 to 1.15. The undocumented
168 optional fifth parameter to C<TIEHASH> has been removed. This was intended
169 to provide control of the callback used by C<gdbm*> functions in case of
170 fatal errors (such as filesystem problems), but did not work (and could
171 never have worked). No code on CPAN even attempted to use it. The callback
172 is now always the previous default, C<croak>. Problems on some platforms with
173 how the C<C> C<croak> function is called have also been resolved.
174
175 =back
176
177 =head1 Documentation
178
179 =head2 Changes to Existing Documentation
180
181 =head3 L<perlapi/Character classes>
182
183 =over 4
184
185 =item *
186
187 There are quite a few macros callable from XS modules that classify
188 characters into things like alphabetic, punctuation, etc.  More of these
189 are now documented, including ones which work on characters whose code
190 points are outside the Latin-1 range.
191
192 =back
193
194 =head1 Diagnostics
195
196 The following additions or changes have been made to diagnostic output,
197 including warnings and fatal error messages.  For the complete list of
198 diagnostic messages, see L<perldiag>.
199
200 =head2 Changes to Existing Diagnostics
201
202 =over 4
203
204 =item *
205
206 L<Constant(%s): Call to &{$^H{%s}} did not return a defined value|perldiag/Constant(%s): Call to &{$^H{%s}} did not return a defined value>
207
208 Constant overloading that returns C<undef> results in this error message.
209 For numeric constants, it used to say "Constant(undef)".  "undef" has been
210 replaced with the number itself.
211
212 =back
213
214 =head1 Internal Changes
215
216 =over 4
217
218 =item *
219
220 SvUPGRADE() is no longer an expression. Originally this macro (and its
221 underlying function, sv_upgrade()) were documented as boolean, although
222 in reality they always croaked on error and never returned false. In 2005
223 the documentation was updated to specify a void return value, but
224 SvUPGRADE() was left always returning 1 for backwards compatibility. This
225 has now been removed, and SvUPGRADE() is now a statement with no return
226 value.
227
228 So this is now a syntax error:
229
230     if (!SvUPGRADE(sv)) { croak(...); }
231
232 If you have code like that, simply replace it with
233
234     SvUPGRADE(sv);
235
236 or to to avoid compiler warnings with older perls, possibly
237
238     (void)SvUPGRADE(sv);
239
240 =item *
241
242 Perl has a new copy-on-write mechanism that allows any SvPOK scalar to be
243 upgraded to a copy-on-write scalar.  A reference count on the string buffer
244 is stored in the string buffer itself.
245
246 This breaks a few XS modules by allowing copy-on-write scalars to go
247 through code paths that never encountered them before.
248
249 This behaviour can still be disabled by running F<Configure> with
250 B<-Accflags=-DPERL_NO_COW>.  This option will probably be removed in Perl
251 5.20.
252
253 =item *
254
255 Copy-on-write no longer uses the SvFAKE and SvREADONLY flags.  Hence,
256 SvREADONLY indicates a true read-only SV.
257
258 Use the SvIsCOW macro (as before) to identify a copy-on-write scalar.
259
260 =item *
261
262 C<PL_sawampersand> is now a constant.  The switch this variable provided
263 (to enable/disable the pre-match copy depending on whether C<$&> had been
264 seen) has been removed and replaced with copy-on-write, eliminating a few
265 bugs.
266
267 The previous behaviour can still be enabled by running F<Configure> with
268 B<-Accflags=-DPERL_SAWAMPERSAND>.
269
270 =item *
271
272 PL_glob_index is gone.
273
274 =back
275
276 =head1 Selected Bug Fixes
277
278 =over 4
279
280 =item *
281
282 C<sort {undef} ...> under fatal warnings no longer crashes.  It started
283 crashing in Perl 5.16.
284
285 =item *
286
287 Stashes blessed into each other
288 (C<bless \%Foo::, 'Bar'; bless \%Bar::, 'Foo'>) no longer result in double
289 frees.  This bug started happening in Perl 5.16.
290
291 =item *
292
293 Numerous memory leaks have been fixed, mostly involving fatal warnings and
294 syntax errors.
295
296 =item *
297
298 Lexical constants (C<my sub answer () { 42 }>) no longer cause double
299 frees.
300
301 =item *
302
303 Constant subroutine redefinition warns by default, but lexical constants
304 were accidentally exempt from default warnings.  This has been corrected.
305
306 =item *
307
308 Some failed regular expression matches such as C<'f' =~ /../g> were not
309 resetting C<pos>.  Also, "match-once" patterns (C<m?...?g>) failed to reset
310 it, too, when invoked a second time [perl #23180].
311
312 =item *
313
314 Accessing C<$&> after a pattern match now works if it had not been seen
315 before the match.  I.e., this applies to C<${'&'}> (under C<no strict>) and
316 C<eval '$&'>.  The same applies to C<$'> and C<$`> [perl #4289].
317
318 =item *
319
320 Several bugs involving C<local *ISA> and C<local *Foo::> causing stale
321 MRO caches have been fixed.  
322
323 =item *
324
325 Defining a subroutine when its typeglob has been aliased no longer results
326 in stale method caches.  This bug was introduced in Perl 5.10.
327
328 =item *
329
330 Localising a typeglob containing a subroutine when the typeglob's package
331 has been deleted from its parent stash no longer produces an error.  This
332 bug was introduced in Perl 5.14.
333
334 =item *
335
336 Under some circumstances, C<local *method=...> would fail to reset method
337 caches upon scope exit.
338
339 =item *
340
341 C</[.foo.]/> is no longer an error, but produces a warning (as before) and
342 is treated as C</[.fo]/> [perl #115818].
343
344 =item *
345
346 C<goto $tied_var> now calls FETCH before deciding what type of goto
347 (subroutine or label) this is.
348
349 =item *
350
351 Renaming packages through glob assignment
352 (C<*Foo:: = *Bar::; *Bar:: = *Baz::>) in combination with C<m?...?> and
353 C<reset> no longer makes threaded builds crash.
354
355 =item *
356
357 An earlier release in the 5.17.x series could crash if user code prevented
358 _charnames from loading via C<$INC{'_charnames.pm'}++>.
359
360 =item *
361
362 A number of bugs related to hash assignment have been fixed:
363
364 =over 8
365
366 =item
367
368 The expression C<scalar(%h = (1, 1, 1, 1))> now returns C<4>, not C<2>.
369
370 =item
371
372 Perl now issues the same warning on C<($s, %h) = (1, {})> as it does for
373 C<(%h) = ({})>, "Reference found where even-sized list expected".
374
375 =item
376
377 The return value of C<%h = (1, 1, 1)> (in list context was wrong. It would
378 return I<just> those items instead of returning an additional C<undef> value
379 for the missing value in the assignment.
380
381 =back
382
383 =back
384
385 =head1 Acknowledgements
386
387 Perl 5.17.7 represents approximately 4 weeks of development since Perl 5.17.6
388 and contains approximately 30,000 lines of changes across 490 files from 26
389 authors.
390
391 Perl continues to flourish into its third decade thanks to a vibrant community
392 of users and developers. The following people are known to have contributed the
393 improvements that became Perl 5.17.7:
394
395 Alexandr Ciornii, Bob Ernst, Brian Carlson, Chris 'BinGOs' Williams, Craig A.
396 Berry, Daniel Dragan, Dave Rolsky, David Mitchell, Father Chrysostomos, Hugo
397 van der Sanden, James E Keenan, Joel Berger, Karl Williamson, Lukas Mai, Martin
398 Hasch, Matthew Horsfall, Nicholas Clark, Ricardo Signes, Ruslan Zakirov, Sergey
399 Alekseev, Steffen Müller, Sullivan Beck, Sven Strickroth, Sébastien
400 Aperghis-Tramoni, Tony Cook, Yves Orton.
401
402 The list above is almost certainly incomplete as it is automatically generated
403 from version control history. In particular, it does not include the names of
404 the (very much appreciated) contributors who reported issues to the Perl bug
405 tracker.
406
407 Many of the changes included in this version originated in the CPAN modules
408 included in Perl's core. We're grateful to the entire CPAN community for
409 helping Perl to flourish.
410
411 For a more complete list of all of Perl's historical contributors, please see
412 the F<AUTHORS> file in the Perl source distribution.
413
414 =head1 Reporting Bugs
415
416 If you find what you think is a bug, you might check the articles recently
417 posted to the comp.lang.perl.misc newsgroup and the perl bug database at
418 http://rt.perl.org/perlbug/ .  There may also be information at
419 http://www.perl.org/ , the Perl Home Page.
420
421 If you believe you have an unreported bug, please run the L<perlbug> program
422 included with your release.  Be sure to trim your bug down to a tiny but
423 sufficient test case.  Your bug report, along with the output of C<perl -V>,
424 will be sent off to perlbug@perl.org to be analysed by the Perl porting team.
425
426 If the bug you are reporting has security implications, which make it
427 inappropriate to send to a publicly archived mailing list, then please send it
428 to perl5-security-report@perl.org.  This points to a closed subscription
429 unarchived mailing list, which includes all the core committers, who will be
430 able to help assess the impact of issues, figure out a resolution, and help
431 co-ordinate the release of patches to mitigate or fix the problem across all
432 platforms on which Perl is supported.  Please only use this address for
433 security issues in the Perl core, not for modules independently distributed on
434 CPAN.
435
436 =head1 SEE ALSO
437
438 The F<Changes> file for an explanation of how to view exhaustive details on
439 what changed.
440
441 The F<INSTALL> file for how to build Perl.
442
443 The F<README> file for general stuff.
444
445 The F<Artistic> and F<Copying> files for copyright information.
446
447 =cut