This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
remove deprecated PL_timesbuf
[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 XXX needs
6 to be processed before release. ]
7
8 perldelta - what is new for perl v5.23.7
9
10 =head1 DESCRIPTION
11
12 This document describes differences between the 5.23.6 release and the 5.23.7
13 release.
14
15 If you are upgrading from an earlier release such as 5.23.5, first read
16 L<perl5236delta>, which describes differences between 5.23.5 and 5.23.6.
17
18 =head1 Notice
19
20 XXX Any important notices here
21
22 =head1 Core Enhancements
23
24 XXX New core language features go here.  Summarize user-visible core language
25 enhancements.  Particularly prominent performance optimisations could go
26 here, but most should go in the L</Performance Enhancements> section.
27
28 [ List each enhancement as a =head2 entry ]
29
30 =head1 Security
31
32 =head2 fix out of boundary access in Win32 path handling
33
34 This is CVE-2015-8608.  For more information see
35 L<[perl #126755]|https://rt.perl.org/Ticket/Display.html?id=126755>
36
37 =head2 fix loss of taint in canonpath
38
39 This is CVE-2015-8607.  For more information see
40 L<[perl #126862]|https://rt.perl.org/Ticket/Display.html?id=126862>
41
42 =head1 Incompatible Changes
43
44 XXX For a release on a stable branch, this section aspires to be:
45
46     There are no changes intentionally incompatible with 5.XXX.XXX
47     If any exist, they are bugs, and we request that you submit a
48     report.  See L</Reporting Bugs> below.
49
50 [ List each incompatible change as a =head2 entry ]
51
52 =head2 C<qr/\b{wb}/> is now tailored to Perl expectations
53
54 This is now more suited to be a drop-in replacement for plain C<\b>, but
55 giving better results for parsing natural language.  Previously it
56 strictly followed the current Unicode rules which calls for it to match
57 between each white space character.  Now it doesn't generally match
58 within spans of white space, behaving like C<\b> does.  See
59 L<perlrebackslash/\b{wb}>
60
61 =head1 Deprecations
62
63 XXX Any deprecated features, syntax, modules etc. should be listed here.
64
65 =head2 Module removals
66
67 XXX Remove this section if inapplicable.
68
69 The following modules will be removed from the core distribution in a
70 future release, and will at that time need to be installed from CPAN.
71 Distributions on CPAN which require these modules will need to list them as
72 prerequisites.
73
74 The core versions of these modules will now issue C<"deprecated">-category
75 warnings to alert you to this fact.  To silence these deprecation warnings,
76 install the modules in question from CPAN.
77
78 Note that these are (with rare exceptions) fine modules that you are encouraged
79 to continue to use.  Their disinclusion from core primarily hinges on their
80 necessity to bootstrapping a fully functional, CPAN-capable Perl installation,
81 not usually on concerns over their design.
82
83 =over
84
85 =item XXX
86
87 XXX Note that deprecated modules should be listed here even if they are listed
88 as an updated module in the L</Modules and Pragmata> section.
89
90 =back
91
92 [ List each other deprecation as a =head2 entry ]
93
94 =head1 Performance Enhancements
95
96 XXX Changes which enhance performance without changing behaviour go here.
97 There may well be none in a stable release.
98
99 [ List each enhancement as a =item entry ]
100
101 =over 4
102
103 =item *
104
105 XXX
106
107 =back
108
109 =head1 Modules and Pragmata
110
111 XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
112 go here.  If Module::CoreList is updated, generate an initial draft of the
113 following sections using F<Porting/corelist-perldelta.pl>.  A paragraph summary
114 for important changes should then be added by hand.  In an ideal world,
115 dual-life modules would have a F<Changes> file that could be cribbed.
116
117 [ Within each section, list entries as a =item entry ]
118
119 =head2 New Modules and Pragmata
120
121 =over 4
122
123 =item *
124
125 XXX
126
127 =back
128
129 =head2 Updated Modules and Pragmata
130
131 =over 4
132
133 =item *
134
135 L<Module::CoreList> has been upgraded from version 5.20151220 to 5.20160120.
136
137 =item *
138
139 The F<cpan/podlators/> bundle has been upgraded from version 2.28 to 4.04.
140
141 =back
142
143 =head2 Removed Modules and Pragmata
144
145 =over 4
146
147 =item *
148
149 XXX
150
151 =back
152
153 =head1 Documentation
154
155 XXX Changes to files in F<pod/> go here.  Consider grouping entries by
156 file and be sure to link to the appropriate page, e.g. L<perlfunc>.
157
158 =head2 New Documentation
159
160 XXX Changes which create B<new> files in F<pod/> go here.
161
162 =head3 L<XXX>
163
164 XXX Description of the purpose of the new file here
165
166 =head2 Changes to Existing Documentation
167
168 XXX Changes which significantly change existing files in F<pod/> go here.
169 However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
170 section.
171
172 =head3 L<XXX>
173
174 =over 4
175
176 =item *
177
178 XXX Description of the change here
179
180 =back
181
182 =head1 Diagnostics
183
184 The following additions or changes have been made to diagnostic output,
185 including warnings and fatal error messages.  For the complete list of
186 diagnostic messages, see L<perldiag>.
187
188 XXX New or changed warnings emitted by the core's C<C> code go here.  Also
189 include any changes in L<perldiag> that reconcile it to the C<C> code.
190
191 =head2 New Diagnostics
192
193 XXX Newly added diagnostic messages go under here, separated into New Errors
194 and New Warnings
195
196 =head3 New Errors
197
198 =over 4
199
200 =item *
201
202 XXX L<message|perldiag/"message">
203
204 =back
205
206 =head3 New Warnings
207
208 =over 4
209
210 =item *
211
212 XXX L<message|perldiag/"message">
213
214 =back
215
216 =head2 Changes to Existing Diagnostics
217
218 XXX Changes (i.e. rewording) of diagnostic messages go here
219
220 =over 4
221
222 =item *
223
224 Accessing the C<IO> part of a glob as C<FILEHANDLE> instead of C<IO> is no
225 longer deprecated.  It is discouraged to encourage uniformity (so that, for
226 example, one can grep more easily) but it will not be removed. [perl #127060]
227
228 =back
229
230 =head1 Utility Changes
231
232 XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here.
233 Most of these are built within the directory F<utils>.
234
235 [ List utility changes as a =head2 entry for each utility and =item
236 entries for each change
237 Use L<XXX> with program names to get proper documentation linking. ]
238
239 =head2 L<XXX>
240
241 =over 4
242
243 =item *
244
245 XXX
246
247 =back
248
249 =head1 Configuration and Compilation
250
251 XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
252 go here.  Any other changes to the Perl build process should be listed here.
253 However, any platform-specific changes should be listed in the
254 L</Platform Support> section, instead.
255
256 [ List changes as a =item entry ].
257
258 =over 4
259
260 =item *
261
262 F<Configure> no longer probes for F<libnm> by default.  Originally
263 this was the "New Math" library, but the name has been re-used by the
264 GNOME NetworkManager.  [perl #127131]
265
266 =back
267
268 =head1 Testing
269
270 XXX Any significant changes to the testing of a freshly built perl should be
271 listed here.  Changes which create B<new> files in F<t/> go here as do any
272 large changes to the testing harness (e.g. when parallel testing was added).
273 Changes to existing files in F<t/> aren't worth summarizing, although the bugs
274 that they represent may be covered elsewhere.
275
276 [ List each test improvement as a =item entry ]
277
278 =over 4
279
280 =item *
281
282 XXX
283
284 =back
285
286 =head1 Platform Support
287
288 XXX Any changes to platform support should be listed in the sections below.
289
290 [ Within the sections, list each platform as a =item entry with specific
291 changes as paragraphs below it. ]
292
293 =head2 New Platforms
294
295 XXX List any platforms that this version of perl compiles on, that previous
296 versions did not.  These will either be enabled by new files in the F<hints/>
297 directories, or new subdirectories and F<README> files at the top level of the
298 source tree.
299
300 =over 4
301
302 =item XXX-some-platform
303
304 XXX
305
306 =back
307
308 =head2 Discontinued Platforms
309
310 XXX List any platforms that this version of perl no longer compiles on.
311
312 =over 4
313
314 =item XXX-some-platform
315
316 XXX
317
318 =back
319
320 =head2 Platform-Specific Notes
321
322 XXX List any changes for specific platforms.  This could include configuration
323 and compilation changes or changes in portability/compatibility.  However,
324 changes within modules for platforms should generally be listed in the
325 L</Modules and Pragmata> section.
326
327 =over 4
328
329 =item XXX-some-platform
330
331 XXX
332
333 =back
334
335 =head1 Internal Changes
336
337 XXX Changes which affect the interface available to C<XS> code go here.  Other
338 significant internal changes for future core maintainers should be noted as
339 well.
340
341 =over 4
342
343 =item *
344
345 The obscure C<PL_timesbuf> variable, effectively a vestige of Perl 1, has
346 been removed. It was documented as deprecated in Perl 5.20, with a statement
347 that it would be removed early in the 5.21.x series; that has now finally
348 happened.  [perl #121351]
349
350 =back
351
352 =head1 Selected Bug Fixes
353
354 XXX Important bug fixes in the core language are summarized here.  Bug fixes in
355 files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>.
356
357 [ List each fix as a =item entry ]
358
359 =over 4
360
361 =item *
362
363 A regression that allowed undeclared barewords as hash keys to work despite
364 strictures has been fixed. [perl #126981]
365
366 =item *
367
368 Calls to the placeholder C<&PL_sv_yes> used internally when an
369 import() or unimport() method isn't found now correctly handle scalar
370 context.  [perl #126042]
371
372 =item *
373
374 Fixed some problems introduced in 5.23.2 with list assignment dealing
375 with magic and XS functions returning their arguments.  [perl #126633]
376
377 =item *
378
379 Report more context when we see an array where we expect to see an
380 operator and avoid an assertion failure.  [perl #123737]
381
382 =item *
383
384 Modifying an array that was previously a package C<@ISA> no longer
385 causes assertion failures or crashes.  [perl #123788]
386
387 =back
388
389 =head1 Known Problems
390
391 XXX Descriptions of platform agnostic bugs we know we can't fix go here.  Any
392 tests that had to be C<TODO>ed for the release would be noted here.  Unfixed
393 platform specific bugs also go here.
394
395 [ List each fix as a =item entry ]
396
397 =over 4
398
399 =item *
400
401 XXX
402
403 =back
404
405 =head1 Errata From Previous Releases
406
407 =over 4
408
409 =item *
410
411 XXX Add anything here that we forgot to add, or were mistaken about, in
412 the perldelta of a previous release.
413
414 =back
415
416 =head1 Obituary
417
418 XXX If any significant core contributor has died, we've added a short obituary
419 here.
420
421 =head1 Acknowledgements
422
423 XXX Generate this with:
424
425   perl Porting/acknowledgements.pl v5.23.6..HEAD
426
427 =head1 Reporting Bugs
428
429 If you find what you think is a bug, you might check the articles recently
430 posted to the comp.lang.perl.misc newsgroup and the perl bug database at
431 L<https://rt.perl.org/> .  There may also be information at
432 L<http://www.perl.org/> , the Perl Home Page.
433
434 If you believe you have an unreported bug, please run the L<perlbug> program
435 included with your release.  Be sure to trim your bug down to a tiny but
436 sufficient test case.  Your bug report, along with the output of C<perl -V>,
437 will be sent off to perlbug@perl.org to be analysed by the Perl porting team.
438
439 If the bug you are reporting has security implications, which make it
440 inappropriate to send to a publicly archived mailing list, then please send it
441 to perl5-security-report@perl.org.  This points to a closed subscription
442 unarchived mailing list, which includes all the core committers, who will be
443 able to help assess the impact of issues, figure out a resolution, and help
444 co-ordinate the release of patches to mitigate or fix the problem across all
445 platforms on which Perl is supported.  Please only use this address for
446 security issues in the Perl core, not for modules independently distributed on
447 CPAN.
448
449 =head1 SEE ALSO
450
451 The F<Changes> file for an explanation of how to view exhaustive details on
452 what changed.
453
454 The F<INSTALL> file for how to build Perl.
455
456 The F<README> file for general stuff.
457
458 The F<Artistic> and F<Copying> files for copyright information.
459
460 =cut