This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
1184084ec0d367b1dfe0c3308288882daeabae84
[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.0
9
10 =head1 DESCRIPTION
11
12 This document describes differences between the 5.16.0 release and
13 the 5.17.0 release.
14
15 If you are upgrading from an earlier release such as 5.16.0, first read
16 L<perl5160delta>, which describes differences between 5.15.0 and
17 5.16.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 =head1 Security
32
33 XXX Any security-related notices go here.  In particular, any security
34 vulnerabilities closed should be noted here rather than in the
35 L</Selected Bug Fixes> section.
36
37 [ List each security issue as a =head2 entry ]
38
39 =head1 Incompatible Changes
40
41 XXX For a release on a stable branch, this section aspires to be:
42
43     There are no changes intentionally incompatible with 5.XXX.XXX
44     If any exist, they are bugs, and we request that you submit a
45     report.  See L</Reporting Bugs> below.
46
47 [ List each incompatible change as a =head2 entry ]
48
49 =head1 Deprecations
50
51 XXX Any deprecated features, syntax, modules etc. should be listed here.
52 In particular, deprecated modules should be listed here even if they are
53 listed as an updated module in the L</Modules and Pragmata> section.
54
55 [ List each deprecation as a =head2 entry ]
56
57 =head1 Performance Enhancements
58
59 XXX Changes which enhance performance without changing behaviour go here. There
60 may well be none in a stable release.
61
62 [ List each enhancement as a =item entry ]
63
64 =over 4
65
66 =item *
67
68 XXX
69
70 =back
71
72 =head1 Modules and Pragmata
73
74 XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
75 go here.  If Module::CoreList is updated, generate an initial draft of the
76 following sections using F<Porting/corelist-perldelta.pl>, which prints stub
77 entries to STDOUT.  Results can be pasted in place of the '=head2' entries
78 below.  A paragraph summary for important changes should then be added by hand.
79 In an ideal world, dual-life modules would have a F<Changes> file that could be
80 cribbed.
81
82 [ Within each section, list entries as a =item entry ]
83
84 =head2 New Modules and Pragmata
85
86 =over 4
87
88 =item *
89
90 XXX
91
92 =back
93
94 =head2 Updated Modules and Pragmata
95
96 =over 4
97
98 =item *
99
100 L<Hash::Util> has been upgraded from version 0.11 to version 0.12.
101
102 C<hash_unlocked> and C<hashref_unlocked> now returns true if the hash is
103 unlocked, instead of always returning false [perl #112126].
104
105 C<hash_unlocked>, C<hashref_unlocked>, C<lock_hash_recurse> and
106 C<unlock_hash_recurse> are now exportable [perl #112126].
107
108 Two new functions, C<hash_locked> and C<hashref_locked>, have been added.
109 Oddly enough, these two functions were already exported, even though they
110 did not exist [perl #112126].
111
112 =item *
113
114 L<Storable> has been upgraded from version 2.34 to version 2.35.
115
116 Modifying C<$_[0]> within C<STORABLE_freeze> no longer results in crashes
117 [perl #112358].
118
119 =back
120
121 =head2 Removed Modules and Pragmata
122
123 =over 4
124
125 =item *
126
127 XXX
128
129 =back
130
131 =head1 Documentation
132
133 XXX Changes to files in F<pod/> go here.  Consider grouping entries by
134 file and be sure to link to the appropriate page, e.g. L<perlfunc>.
135
136 =head2 New Documentation
137
138 XXX Changes which create B<new> files in F<pod/> go here.
139
140 =head3 L<XXX>
141
142 XXX Description of the purpose of the new file here
143
144 =head2 Changes to Existing Documentation
145
146 XXX Changes which significantly change existing files in F<pod/> go here.
147 However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
148 section.
149
150 =head3 L<XXX>
151
152 =over 4
153
154 =item *
155
156 XXX Description of the change here
157
158 =back
159
160 =head1 Diagnostics
161
162 The following additions or changes have been made to diagnostic output,
163 including warnings and fatal error messages.  For the complete list of
164 diagnostic messages, see L<perldiag>.
165
166 XXX New or changed warnings emitted by the core's C<C> code go here. Also
167 include any changes in L<perldiag> that reconcile it to the C<C> code.
168
169 [ Within each section, list entries as a =item entry that links to perldiag,
170   e.g.
171
172   =item *
173
174   L<Invalid version object|perldiag/"Invalid version object">
175 ]
176
177 =head2 New Diagnostics
178
179 XXX Newly added diagnostic messages go here
180
181 =head3 New Errors
182
183 =over 4
184
185 =item *
186
187 XXX L<message|perldiag/"message">
188
189 =back
190
191 =head3 New Warnings
192
193 =over 4
194
195 =item *
196
197 XXX L<message|perldiag/"message">
198
199 =back
200
201 =head2 Changes to Existing Diagnostics
202
203 XXX Changes (i.e. rewording) of diagnostic messages go here
204
205 =over 4
206
207 =item *
208
209 XXX Describe change here
210
211 =back
212
213 =head1 Utility Changes
214
215 XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go
216 here. Most of these are built within the directories F<utils> and F<x2p>.
217
218 [ List utility changes as a =head3 entry for each utility and =item
219 entries for each change
220 Use L<XXX> with program names to get proper documentation linking. ]
221
222 =head3 L<XXX>
223
224 =over 4
225
226 =item *
227
228 XXX
229
230 =back
231
232 =head1 Configuration and Compilation
233
234 XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
235 go here.  Any other changes to the Perl build process should be listed here.
236 However, any platform-specific changes should be listed in the
237 L</Platform Support> section, instead.
238
239 [ List changes as a =item entry ].
240
241 =over 4
242
243 =item *
244
245 XXX
246
247 =back
248
249 =head1 Testing
250
251 XXX Any significant changes to the testing of a freshly built perl should be
252 listed here.  Changes which create B<new> files in F<t/> go here as do any
253 large changes to the testing harness (e.g. when parallel testing was added).
254 Changes to existing files in F<t/> aren't worth summarising, although the bugs
255 that they represent may be covered elsewhere.
256
257 [ List each test improvement as a =item entry ]
258
259 =over 4
260
261 =item *
262
263 XXX
264
265 =back
266
267 =head1 Platform Support
268
269 XXX Any changes to platform support should be listed in the sections below.
270
271 [ Within the sections, list each platform as a =item entry with specific
272 changes as paragraphs below it. ]
273
274 =head2 New Platforms
275
276 XXX List any platforms that this version of perl compiles on, that previous
277 versions did not. These will either be enabled by new files in the F<hints/>
278 directories, or new subdirectories and F<README> files at the top level of the
279 source tree.
280
281 =over 4
282
283 =item XXX-some-platform
284
285 XXX
286
287 =back
288
289 =head2 Discontinued Platforms
290
291 XXX List any platforms that this version of perl no longer compiles on.
292
293 =over 4
294
295 =item XXX-some-platform
296
297 XXX
298
299 =back
300
301 =head2 Platform-Specific Notes
302
303 XXX List any changes for specific platforms. This could include configuration
304 and compilation changes or changes in portability/compatibility.  However,
305 changes within modules for platforms should generally be listed in the
306 L</Modules and Pragmata> section.
307
308 =over 4
309
310 =item XXX-some-platform
311
312 XXX
313
314 =back
315
316 =head1 Internal Changes
317
318 XXX Changes which affect the interface available to C<XS> code go here.
319 Other significant internal changes for future core maintainers should
320 be noted as well.
321
322 [ List each change as a =item entry ]
323
324 =over 4
325
326 =item *
327
328 XXX
329
330 =back
331
332 =head1 Selected Bug Fixes
333
334 XXX Important bug fixes in the core language are summarised here.
335 Bug fixes in files in F<ext/> and F<lib/> are best summarised in
336 L</Modules and Pragmata>.
337
338 [ List each fix as a =item entry ]
339
340 =over 4
341
342 =item *
343
344 C<goto ''> now looks for an empty label, producing the "goto must have
345 label" error message, instead of exiting the program [perl #111794].
346
347 =item *
348
349 C<goto "\0"> now dies with "Can't find label" instead of "goto must have
350 label".
351
352 =item *
353
354 The C function C<hv_store> used to result in crashes when used on C<%^H>
355 [perl #111000].
356
357 =item *
358
359 A call checker attached to a closure prototype via C<cv_set_call_checker>
360 is now copied to closures cloned from it.  So C<cv_set_call_checker> now
361 works inside an attribute handler for a closure.
362
363 =item *
364
365 Writing to C<$^N> used to have no effect.  Now it croaks with "Modification
366 of a read-only value" by default, but that can be overridden by a custom
367 regular expression engine, as with C<$1> [perl #112184].
368
369 =back
370
371 =head1 Known Problems
372
373 XXX Descriptions of platform agnostic bugs we know we can't fix go here. Any
374 tests that had to be C<TODO>ed for the release would be noted here, unless
375 they were specific to a particular platform (see below).
376
377 This is a list of some significant unfixed bugs, which are regressions
378 from either 5.XXX.XXX or 5.XXX.XXX.
379
380 [ List each fix as a =item entry ]
381
382 =over 4
383
384 =item *
385
386 XXX
387
388 =back
389
390 =head1 Obituary
391
392 XXX If any significant core contributor has died, we've added a short obituary
393 here.
394
395 =head1 Acknowledgements
396
397 XXX Generate this with:
398
399   perl Porting/acknowledgements.pl v5.16.0..HEAD
400
401 =head1 Reporting Bugs
402
403 If you find what you think is a bug, you might check the articles
404 recently posted to the comp.lang.perl.misc newsgroup and the perl
405 bug database at http://rt.perl.org/perlbug/ .  There may also be
406 information at http://www.perl.org/ , the Perl Home Page.
407
408 If you believe you have an unreported bug, please run the L<perlbug>
409 program included with your release.  Be sure to trim your bug down
410 to a tiny but sufficient test case.  Your bug report, along with the
411 output of C<perl -V>, will be sent off to perlbug@perl.org to be
412 analysed by the Perl porting team.
413
414 If the bug you are reporting has security implications, which make it
415 inappropriate to send to a publicly archived mailing list, then please send
416 it to perl5-security-report@perl.org. This points to a closed subscription
417 unarchived mailing list, which includes
418 all the core committers, who will be able
419 to help assess the impact of issues, figure out a resolution, and help
420 co-ordinate the release of patches to mitigate or fix the problem across all
421 platforms on which Perl is supported. Please only use this address for
422 security issues in the Perl core, not for modules independently
423 distributed on CPAN.
424
425 =head1 SEE ALSO
426
427 The F<Changes> file for an explanation of how to view exhaustive details
428 on what changed.
429
430 The F<INSTALL> file for how to build Perl.
431
432 The F<README> file for general stuff.
433
434 The F<Artistic> and F<Copying> files for copyright information.
435
436 =cut