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