This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
d6ed89c1e23d3dd3496958cdfcba58df814baa73
[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.17.1
9
10 =head1 DESCRIPTION
11
12 This document describes differences between the 5.17.0 release and
13 the 5.17.1 release.
14
15 If you are upgrading from an earlier release such as 5.16.0, first read
16 L<perl5170delta>, which describes differences between 5.16.0 and
17 5.17.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 More CORE:: subs
32
33 Several more built-in functions have been added as subroutines to the
34 CORE:: namespace, namely, those non-overridable keywords that can be
35 implemented without custom parsers: C<defined>, C<delete>, C<exists>,
36 C<glob>, C<pos>, C<protoytpe>, C<scalar>, C<split>, C<study>, C<undef>,
37
38 As some of these have prototypes, C<prototype('CORE::...')> has been
39 changed not to make a distinction between overridable and non-overridable
40 keywords.  This is to make C<prototype('CORE::pos')> consistent with
41 C<prototype(&CORE::pos)>.
42
43 =head1 Security
44
45 XXX Any security-related notices go here.  In particular, any security
46 vulnerabilities closed should be noted here rather than in the
47 L</Selected Bug Fixes> section.
48
49 [ List each security issue as a =head2 entry ]
50
51 =head1 Incompatible Changes
52
53 XXX For a release on a stable branch, this section aspires to be:
54
55     There are no changes intentionally incompatible with 5.XXX.XXX
56     If any exist, they are bugs, and we request that you submit a
57     report.  See L</Reporting Bugs> below.
58
59 =head2 C<\N{BELL}> now refers to U+1F514 instead of U+0007
60
61 Unicode 6.0 reused the name "BELL" for a different code point than it
62 traditionally had meant.  Since Perl v5.14, use of this name still
63 referred to U+0007, but would raise a deprecated warning.  Now, "BELL"
64 refers to U+1F514, and the name for U+0007 is "ALERT".  All the
65 functions in L<charnames> have been correspondingly updated.
66
67 =head1 Deprecations
68
69 XXX Any deprecated features, syntax, modules etc. should be listed here.
70 In particular, deprecated modules should be listed here even if they are
71 listed as an updated module in the L</Modules and Pragmata> section.
72
73 [ List each deprecation as a =head2 entry ]
74
75 =head1 Performance Enhancements
76
77 XXX Changes which enhance performance without changing behaviour go here. There
78 may well be none in a stable release.
79
80 [ List each enhancement as a =item entry ]
81
82 =over 4
83
84 =item *
85
86 XXX
87
88 =back
89
90 =head1 Modules and Pragmata
91
92 XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
93 go here.  If Module::CoreList is updated, generate an initial draft of the
94 following sections using F<Porting/corelist-perldelta.pl>, which prints stub
95 entries to STDOUT.  Results can be pasted in place of the '=head2' entries
96 below.  A paragraph summary for important changes should then be added by hand.
97 In an ideal world, dual-life modules would have a F<Changes> file that could be
98 cribbed.
99
100 [ Within each section, list entries as a =item entry ]
101
102 =head2 New Modules and Pragmata
103
104 =over 4
105
106 =item *
107
108 XXX
109
110 =back
111
112 =head2 Updated Modules and Pragmata
113
114 =over 4
115
116 =item *
117
118 L<ExtUtils::CBuilder> has been upgraded from version 0.280206 to 0.280208.
119
120 Manifest files are now correctly embedded for those versions of VC++ which
121 make use of them.
122
123 =item *
124
125 L<B> has been upgraded from version 1.35 to 1.36.
126
127 C<B::COP::stashlen> has been replaced with C<B::COP::stashoff>.
128
129 C<B::COP::stashpv> now supports UTF8 package names and embedded nulls.
130
131 =item *
132
133 L<ExtUtils::CBuilder> has been upgraded from version 0.280206 to 0.280208.
134
135 It no longer fails when trying to embed manifests on Windows
136 [perl #111782, #111798].
137
138 =item *
139
140 L<File::DosGlob> has been upgraded from version 1.07 to 1.08.
141
142 There are no visible changes, only minor internal refactorings.
143
144 =item *
145
146 L<File::Spec::Unix> has been upgraded from version 3.39_02 to 3.39_03.
147
148 C<abs2rel> could produce incorrect results when given two relative paths or
149 the root directory twice [perl #111510].
150
151 =item *
152
153 L<IO> has been upgraded from version 1.25_06 to 1.25_07.
154
155 C<sync()> can now be called on read-only file handles [perl #64772].
156
157 =item *
158
159 L<Pod::Html> has been upgraded from version 1.15_02 to 1.16.
160
161 The option C<--libpods> has been re-instated. It is deprecated, and its use
162 does nothing other than issue a warning that it is no longer supported.
163
164 =item *
165
166 L<Unicode::UCD> has been upgraded from version 0.43 to 0.44.
167
168 This adds a function L<all_casefolds()|Unicode::UCD/all_casefolds()>
169 that returns all the casefolds.
170
171 =back
172
173 =head2 Removed Modules and Pragmata
174
175 =over 4
176
177 =item *
178
179 XXX
180
181 =back
182
183 =head1 Documentation
184
185 XXX Changes to files in F<pod/> go here.  Consider grouping entries by
186 file and be sure to link to the appropriate page, e.g. L<perlfunc>.
187
188 =head2 New Documentation
189
190 XXX Changes which create B<new> files in F<pod/> go here.
191
192 =head3 L<XXX>
193
194 XXX Description of the purpose of the new file here
195
196 =head2 Changes to Existing Documentation
197
198 XXX Changes which significantly change existing files in F<pod/> go here.
199 However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
200 section.
201
202 =head3 L<XXX>
203
204 =over 4
205
206 =item *
207
208 XXX Description of the change here
209
210 =back
211
212 =head1 Diagnostics
213
214 The following additions or changes have been made to diagnostic output,
215 including warnings and fatal error messages.  For the complete list of
216 diagnostic messages, see L<perldiag>.
217
218 XXX New or changed warnings emitted by the core's C<C> code go here. Also
219 include any changes in L<perldiag> that reconcile it to the C<C> code.
220
221 [ Within each section, list entries as a =item entry that links to perldiag,
222   e.g.
223
224   =item *
225
226   L<Invalid version object|perldiag/"Invalid version object">
227 ]
228
229 =head2 New Diagnostics
230
231 XXX Newly added diagnostic messages go here
232
233 =head3 New Errors
234
235 =over 4
236
237 =item *
238
239 XXX L<message|perldiag/"message">
240
241 =back
242
243 =head3 New Warnings
244
245 =over 4
246
247 =item *
248
249 XXX L<message|perldiag/"message">
250
251 =back
252
253 =head2 Changes to Existing Diagnostics
254
255 XXX Changes (i.e. rewording) of diagnostic messages go here
256
257 =over 4
258
259 =item *
260
261 XXX Describe change here
262
263 =back
264
265 =head2 Removals of Diagnostics
266
267 =over 4
268
269 =item *
270
271 The "Runaway prototype" warning that occurs in bizarre cases has been
272 removed as being unhelpful and inconsistent.
273
274 =back
275
276 =head1 Utility Changes
277
278 XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go
279 here. Most of these are built within the directories F<utils> and F<x2p>.
280
281 [ List utility changes as a =head3 entry for each utility and =item
282 entries for each change
283 Use L<XXX> with program names to get proper documentation linking. ]
284
285 =head3 L<XXX>
286
287 =over 4
288
289 =item *
290
291 XXX
292
293 =back
294
295 =head1 Configuration and Compilation
296
297 XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
298 go here.  Any other changes to the Perl build process should be listed here.
299 However, any platform-specific changes should be listed in the
300 L</Platform Support> section, instead.
301
302 [ List changes as a =item entry ].
303
304 =over 4
305
306 =item *
307
308 XXX
309
310 =back
311
312 =head1 Testing
313
314 XXX Any significant changes to the testing of a freshly built perl should be
315 listed here.  Changes which create B<new> files in F<t/> go here as do any
316 large changes to the testing harness (e.g. when parallel testing was added).
317 Changes to existing files in F<t/> aren't worth summarising, although the bugs
318 that they represent may be covered elsewhere.
319
320 [ List each test improvement as a =item entry ]
321
322 =over 4
323
324 =item *
325
326 XXX
327
328 =back
329
330 =head1 Platform Support
331
332 XXX Any changes to platform support should be listed in the sections below.
333
334 [ Within the sections, list each platform as a =item entry with specific
335 changes as paragraphs below it. ]
336
337 =head2 New Platforms
338
339 XXX List any platforms that this version of perl compiles on, that previous
340 versions did not. These will either be enabled by new files in the F<hints/>
341 directories, or new subdirectories and F<README> files at the top level of the
342 source tree.
343
344 =over 4
345
346 =item XXX-some-platform
347
348 XXX
349
350 =back
351
352 =head2 Discontinued Platforms
353
354 XXX List any platforms that this version of perl no longer compiles on.
355
356 =over 4
357
358 =item XXX-some-platform
359
360 XXX
361
362 =back
363
364 =head2 Platform-Specific Notes
365
366 XXX List any changes for specific platforms. This could include configuration
367 and compilation changes or changes in portability/compatibility.  However,
368 changes within modules for platforms should generally be listed in the
369 L</Modules and Pragmata> section.
370
371 =over 4
372
373 =item Win32
374
375 C<link> on Win32 now attempts to set C<$!> to more appropriate values
376 based on the Win32 API error code. [perl #112272]
377
378 =back
379
380 =head1 Internal Changes
381
382 XXX Changes which affect the interface available to C<XS> code go here.
383 Other significant internal changes for future core maintainers should
384 be noted as well.
385
386 [ List each change as a =item entry ]
387
388 =over 4
389
390 =item *
391
392 The C<study> function was made a no-op in 5.16.  It was simply disabled via
393 a C<return> statement; the code was left in place.  Now the code supporting
394 what C<study> used to do has been removed.
395
396 =item *
397
398 Under threaded perls, there is no longer a separate PV allocated for every
399 COP to store its package name (C<< cop->stashpv >>).  Instead, there is an
400 offset (C<< cop->stashoff >>) into the new C<PL_stashpad> array, which
401 holds stash pointers.
402
403 =back
404
405 =head1 Selected Bug Fixes
406
407 XXX Important bug fixes in the core language are summarised here.
408 Bug fixes in files in F<ext/> and F<lib/> are best summarised in
409 L</Modules and Pragmata>.
410
411 [ List each fix as a =item entry ]
412
413 =over 4
414
415 =item *
416
417 Perl now works as well as can be expected on all releases of Unicode so
418 far.  In v5.16, it worked on Unicodes 6.0 and 6.1, but there were
419 various bugs for earlier releases; the older the release the more
420 problems.
421
422 =item *
423
424 C<vec> no longer produces "uninitialized" warnings in lvalue context
425 [perl #9423].
426
427 =item *
428
429 An optimisation involving fixed strings in regular expressions could cause
430 a severe performance penalty in edge cases.  This has been fixed
431 [perl #76546].
432
433 =item *
434
435 The "Can't find an opnumber" message that C<prototype> produces when passed
436 a string like "CORE::nonexistent_keyword" is now passes UTF8 and embedded
437 nulls through unchanged [perl #97478].
438
439 =item *
440
441 Under threaded perls, a run-time code block in a regular expression could
442 corrupt the package name stored in the op tree, resulting in bad reads
443 in C<caller>, and possibly crashes [perl #113060].
444
445 =item *
446
447 Referencing a closure prototype (C<\&{$_[1]}> in an attribute handler for a
448 closure) no longer results in a copy of the subroutine (or assertion
449 failures on debugging builds).
450
451 =item *
452
453 C<eval '__PACKAGE__'> now returns the right answer on threaded builds if
454 the current package has been assigned over (as in
455 C<*ThisPackage:: = *ThatPackage::>) [perl #78742].
456
457 =item *
458
459 If a package is deleted by code that it calls, it is possible for C<caller>
460 to see a stack frame belonging to that deleted package.  C<caller> could
461 crash if the stash's memory address was reused for a scalar and a
462 substitution was performed on the same scalar [perl #113486].
463
464 =back
465
466 =head1 Known Problems
467
468 XXX Descriptions of platform agnostic bugs we know we can't fix go here. Any
469 tests that had to be C<TODO>ed for the release would be noted here, unless
470 they were specific to a particular platform (see below).
471
472 This is a list of some significant unfixed bugs, which are regressions
473 from either 5.XXX.XXX or 5.XXX.XXX.
474
475 [ List each fix as a =item entry ]
476
477 =over 4
478
479 =item *
480
481 XXX
482
483 =back
484
485 =head1 Obituary
486
487 XXX If any significant core contributor has died, we've added a short obituary
488 here.
489
490 =head1 Acknowledgements
491
492 XXX Generate this with:
493
494   perl Porting/acknowledgements.pl v5.17.0..HEAD
495
496 =head1 Reporting Bugs
497
498 If you find what you think is a bug, you might check the articles
499 recently posted to the comp.lang.perl.misc newsgroup and the perl
500 bug database at http://rt.perl.org/perlbug/ .  There may also be
501 information at http://www.perl.org/ , the Perl Home Page.
502
503 If you believe you have an unreported bug, please run the L<perlbug>
504 program included with your release.  Be sure to trim your bug down
505 to a tiny but sufficient test case.  Your bug report, along with the
506 output of C<perl -V>, will be sent off to perlbug@perl.org to be
507 analysed by the Perl porting team.
508
509 If the bug you are reporting has security implications, which make it
510 inappropriate to send to a publicly archived mailing list, then please send
511 it to perl5-security-report@perl.org. This points to a closed subscription
512 unarchived mailing list, which includes
513 all the core committers, who will be able
514 to help assess the impact of issues, figure out a resolution, and help
515 co-ordinate the release of patches to mitigate or fix the problem across all
516 platforms on which Perl is supported. Please only use this address for
517 security issues in the Perl core, not for modules independently
518 distributed on CPAN.
519
520 =head1 SEE ALSO
521
522 The F<Changes> file for an explanation of how to view exhaustive details
523 on what changed.
524
525 The F<INSTALL> file for how to build Perl.
526
527 The F<README> file for general stuff.
528
529 The F<Artistic> and F<Copying> files for copyright information.
530
531 =cut