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