This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
perldelta for c2538af7458
[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.9
9
10 =head1 DESCRIPTION
11
12 This document describes differences between the 5.23.8 release and the 5.23.9
13 release.
14
15 If you are upgrading from an earlier release such as 5.23.7, first read
16 L<perl5238delta>, which describes differences between 5.23.7 and 5.23.8.
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 =head1 Deprecations
49
50 XXX Any deprecated features, syntax, modules etc. should be listed here.
51
52 =head2 Module removals
53
54 XXX Remove this section if inapplicable.
55
56 The following modules will be removed from the core distribution in a
57 future release, and will at that time need to be installed from CPAN.
58 Distributions on CPAN which require these modules will need to list them as
59 prerequisites.
60
61 The core versions of these modules will now issue C<"deprecated">-category
62 warnings to alert you to this fact.  To silence these deprecation warnings,
63 install the modules in question from CPAN.
64
65 Note that these are (with rare exceptions) fine modules that you are encouraged
66 to continue to use.  Their disinclusion from core primarily hinges on their
67 necessity to bootstrapping a fully functional, CPAN-capable Perl installation,
68 not usually on concerns over their design.
69
70 =over
71
72 =item XXX
73
74 XXX Note that deprecated modules should be listed here even if they are listed
75 as an updated module in the L</Modules and Pragmata> section.
76
77 =back
78
79 [ List each other deprecation as a =head2 entry ]
80
81 =head1 Performance Enhancements
82
83 XXX Changes which enhance performance without changing behaviour go here.
84 There may well be none in a stable release.
85
86 [ List each enhancement as a =item entry ]
87
88 =over 4
89
90 =item *
91
92 XXX
93
94 =back
95
96 =head1 Modules and Pragmata
97
98 XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
99 go here.  If Module::CoreList is updated, generate an initial draft of the
100 following sections using F<Porting/corelist-perldelta.pl>.  A paragraph summary
101 for important changes should then be added by hand.  In an ideal world,
102 dual-life modules would have a F<Changes> file that could be cribbed.
103
104 [ Within each section, list entries as a =item entry ]
105
106 =head2 New Modules and Pragmata
107
108 =over 4
109
110 =item *
111
112 XXX
113
114 =back
115
116 =head2 Updated Modules and Pragmata
117
118 =over 4
119
120 =item *
121
122 L<XXX> has been upgraded from version A.xx to B.yy.
123
124 =item *
125
126 L<Module::CoreList> has been upgraded from version 5.20160121 to
127 5.20160221.
128
129 =back
130
131 =head2 Removed Modules and Pragmata
132
133 =over 4
134
135 =item *
136
137 XXX
138
139 =back
140
141 =head1 Documentation
142
143 XXX Changes to files in F<pod/> go here.  Consider grouping entries by
144 file and be sure to link to the appropriate page, e.g. L<perlfunc>.
145
146 =head2 New Documentation
147
148 XXX Changes which create B<new> files in F<pod/> go here.
149
150 =head3 L<XXX>
151
152 XXX Description of the purpose of the new file here
153
154 =head2 Changes to Existing Documentation
155
156 XXX Changes which significantly change existing files in F<pod/> go here.
157 However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
158 section.
159
160 =head3 L<XXX>
161
162 =over 4
163
164 =item *
165
166 XXX Description of the change here
167
168 =back
169
170 =head1 Diagnostics
171
172 The following additions or changes have been made to diagnostic output,
173 including warnings and fatal error messages.  For the complete list of
174 diagnostic messages, see L<perldiag>.
175
176 XXX New or changed warnings emitted by the core's C<C> code go here.  Also
177 include any changes in L<perldiag> that reconcile it to the C<C> code.
178
179 =head2 New Diagnostics
180
181 XXX Newly added diagnostic messages go under here, separated into New Errors
182 and New Warnings
183
184 =head3 New Errors
185
186 =over 4
187
188 =item *
189
190 XXX L<message|perldiag/"message">
191
192 =back
193
194 =head3 New Warnings
195
196 =over 4
197
198 =item *
199
200 XXX L<message|perldiag/"message">
201
202 =back
203
204 =head2 Changes to Existing Diagnostics
205
206 XXX Changes (i.e. rewording) of diagnostic messages go here
207
208 =over 4
209
210 =item *
211
212 XXX Describe change here
213
214 =back
215
216 =head1 Utility Changes
217
218 XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here.
219 Most of these are built within the directory F<utils>.
220
221 [ List utility changes as a =head2 entry for each utility and =item
222 entries for each change
223 Use L<XXX> with program names to get proper documentation linking. ]
224
225 =head2 L<XXX>
226
227 =over 4
228
229 =item *
230
231 XXX
232
233 =back
234
235 =head1 Configuration and Compilation
236
237 XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
238 go here.  Any other changes to the Perl build process should be listed here.
239 However, any platform-specific changes should be listed in the
240 L</Platform Support> section, instead.
241
242 [ List changes as a =item entry ].
243
244 =over 4
245
246 =item *
247
248 Dtrace builds now build sucessfully on systems with a newer dtrace
249 that require an input object file that uses the probes in the F<.d>
250 file.
251
252 Previously the probe would fail and cause a build failure. [perl
253 #122287]
254
255 =back
256
257 =head1 Testing
258
259 XXX Any significant changes to the testing of a freshly built perl should be
260 listed here.  Changes which create B<new> files in F<t/> go here as do any
261 large changes to the testing harness (e.g. when parallel testing was added).
262 Changes to existing files in F<t/> aren't worth summarizing, although the bugs
263 that they represent may be covered elsewhere.
264
265 [ List each test improvement as a =item entry ]
266
267 =over 4
268
269 =item *
270
271 XXX
272
273 =back
274
275 =head1 Platform Support
276
277 XXX Any changes to platform support should be listed in the sections below.
278
279 [ Within the sections, list each platform as a =item entry with specific
280 changes as paragraphs below it. ]
281
282 =head2 New Platforms
283
284 XXX List any platforms that this version of perl compiles on, that previous
285 versions did not.  These will either be enabled by new files in the F<hints/>
286 directories, or new subdirectories and F<README> files at the top level of the
287 source tree.
288
289 =over 4
290
291 =item XXX-some-platform
292
293 XXX
294
295 =back
296
297 =head2 Discontinued Platforms
298
299 XXX List any platforms that this version of perl no longer compiles on.
300
301 =over 4
302
303 =item XXX-some-platform
304
305 XXX
306
307 =back
308
309 =head2 Platform-Specific Notes
310
311 XXX List any changes for specific platforms.  This could include configuration
312 and compilation changes or changes in portability/compatibility.  However,
313 changes within modules for platforms should generally be listed in the
314 L</Modules and Pragmata> section.
315
316 =over 4
317
318 =item Win32
319
320 Building a 64-bit perl with a 64-bit GCC but a 32-bit gmake would
321 result in an invalid C<$Config{archname}> for the resulting perl.
322 [perl #127584]
323
324 =back
325
326 =head1 Internal Changes
327
328 XXX Changes which affect the interface available to C<XS> code go here.  Other
329 significant internal changes for future core maintainers should be noted as
330 well.
331
332 [ List each change as a =item entry ]
333
334 =over 4
335
336 =item *
337
338 XXX
339
340 =back
341
342 =head1 Selected Bug Fixes
343
344 XXX Important bug fixes in the core language are summarized here.  Bug fixes in
345 files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>.
346
347 [ List each fix as a =item entry ]
348
349 =over 4
350
351 =item *
352
353 It now works properly to specify a user-defined property, such as
354
355  qr/\p{mypkg1::IsMyProperty}/i
356
357 with C</i> caseless matching, an explicit package name, and
358 I<IsMyProperty> not defined at the time of the pattern compilation.
359
360 =item *
361
362 Perl's memcpy(), memmove(), memset() and memcmp() fallbacks are now
363 more compatible with the originals.  [perl #127619]
364
365 =item *
366
367 The peak memory usage when compiling some regular expression patterns is
368 now significantly smaller. [perl #127392]
369
370 =item *
371
372 A case has been fixed in which malformed UTF-8 in the source of a Perl
373 script caused an assertion failure instead of an error message. [perl
374 #127262]
375
376 =back
377
378 =head1 Known Problems
379
380 XXX Descriptions of platform agnostic bugs we know we can't fix go here.  Any
381 tests that had to be C<TODO>ed for the release would be noted here.  Unfixed
382 platform specific bugs also go here.
383
384 [ List each fix as a =item entry ]
385
386 =over 4
387
388 =item *
389
390 XXX
391
392 =back
393
394 =head1 Errata From Previous Releases
395
396 =over 4
397
398 =item *
399
400 XXX Add anything here that we forgot to add, or were mistaken about, in
401 the perldelta of a previous release.
402
403 =back
404
405 =head1 Obituary
406
407 XXX If any significant core contributor has died, we've added a short obituary
408 here.
409
410 =head1 Acknowledgements
411
412 XXX Generate this with:
413
414   perl Porting/acknowledgements.pl v5.23.8..HEAD
415
416 =head1 Reporting Bugs
417
418 If you find what you think is a bug, you might check the articles recently
419 posted to the comp.lang.perl.misc newsgroup and the perl bug database at
420 L<https://rt.perl.org/> .  There may also be information at
421 L<http://www.perl.org/> , the Perl Home Page.
422
423 If you believe you have an unreported bug, please run the L<perlbug> program
424 included with your release.  Be sure to trim your bug down to a tiny but
425 sufficient test case.  Your bug report, along with the output of C<perl -V>,
426 will be sent off to perlbug@perl.org to be analysed by the Perl porting team.
427
428 If the bug you are reporting has security implications, which make it
429 inappropriate to send to a publicly archived mailing list, then please send it
430 to perl5-security-report@perl.org.  This points to a closed subscription
431 unarchived mailing list, which includes all the core committers, who will be
432 able to help assess the impact of issues, figure out a resolution, and help
433 co-ordinate the release of patches to mitigate or fix the problem across all
434 platforms on which Perl is supported.  Please only use this address for
435 security issues in the Perl core, not for modules independently distributed on
436 CPAN.
437
438 =head1 SEE ALSO
439
440 The F<Changes> file for an explanation of how to view exhaustive details on
441 what changed.
442
443 The F<INSTALL> file for how to build Perl.
444
445 The F<README> file for general stuff.
446
447 The F<Artistic> and F<Copying> files for copyright information.
448
449 =cut