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