This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
bfd4b49e9ae36ef0b0b74f351a1daf6dc328d131
[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.29.10
9
10 =head1 DESCRIPTION
11
12 This document describes differences between the 5.29.9 release and the 5.29.10
13 release.
14
15 If you are upgrading from an earlier release such as 5.29.8, first read
16 L<perl5299delta>, which describes differences between 5.29.8 and 5.29.9.
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 =head2 Perl now supports draft Unicode 12.1
29
30 Unicode 12.1 differs from 12.0 only in the addition of a single
31 character, that for the new Japanese era name.  The intent is to ship
32 Perl 5.30 with Unicode 12.1.  The final release of 12.1 is scheduled for
33 May 7, 2019.  Hopefully, there won't be any code changes to the draft
34 after the release of Perl 5.29.10.
35
36 =head1 Security
37
38 XXX Any security-related notices go here.  In particular, any security
39 vulnerabilities closed should be noted here rather than in the
40 L</Selected Bug Fixes> section.
41
42 [ List each security issue as a =head2 entry ]
43
44 =head1 Incompatible Changes
45
46 XXX For a release on a stable branch, this section aspires to be:
47
48     There are no changes intentionally incompatible with 5.XXX.XXX
49     If any exist, they are bugs, and we request that you submit a
50     report.  See L</Reporting Bugs> below.
51
52 [ List each incompatible change as a =head2 entry ]
53
54 =head1 Deprecations
55
56 XXX Any deprecated features, syntax, modules etc. should be listed here.
57
58 =head2 Module removals
59
60 XXX Remove this section if not applicable.
61
62 The following modules will be removed from the core distribution in a
63 future release, and will at that time need to be installed from CPAN.
64 Distributions on CPAN which require these modules will need to list them as
65 prerequisites.
66
67 The core versions of these modules will now issue C<"deprecated">-category
68 warnings to alert you to this fact.  To silence these deprecation warnings,
69 install the modules in question from CPAN.
70
71 Note that these are (with rare exceptions) fine modules that you are encouraged
72 to continue to use.  Their disinclusion from core primarily hinges on their
73 necessity to bootstrapping a fully functional, CPAN-capable Perl installation,
74 not usually on concerns over their design.
75
76 =over
77
78 =item XXX
79
80 XXX Note that deprecated modules should be listed here even if they are listed
81 as an updated module in the L</Modules and Pragmata> section.
82
83 =back
84
85 [ List each other deprecation as a =head2 entry ]
86
87 =head1 Performance Enhancements
88
89 XXX Changes which enhance performance without changing behaviour go here.
90 There may well be none in a stable release.
91
92 [ List each enhancement as an =item entry ]
93
94 =over 4
95
96 =item *
97
98 XXX
99
100 =back
101
102 =head1 Modules and Pragmata
103
104 XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
105 go here.  If Module::CoreList is updated, generate an initial draft of the
106 following sections using F<Porting/corelist-perldelta.pl>.  A paragraph summary
107 for important changes should then be added by hand.  In an ideal world,
108 dual-life modules would have a F<Changes> file that could be cribbed.
109
110 The list of new and updated modules is modified automatically as part of
111 preparing a Perl release, so the only reason to manually add entries here is if
112 you're summarising the important changes in the module update. (Also, if the
113 manually-added details don't match the automatically-generated ones, the
114 release manager will have to investigate the situation carefully.)
115
116 [ Within each section, list entries as an =item entry ]
117
118 =head2 New Modules and Pragmata
119
120 =over 4
121
122 =item *
123
124 XXX Remove this section if not applicable.
125
126 =back
127
128 =head2 Updated Modules and Pragmata
129
130 =over 4
131
132 =item *
133
134 L<XXX> has been upgraded from version A.xx to B.yy.
135
136 If there was something important to note about this change, include that here.
137
138 =item *
139
140 L<Module::CoreList> has been upgraded from version 5.20190320 to 5.20190420.
141
142 =back
143
144 =head2 Removed Modules and Pragmata
145
146 =over 4
147
148 =item *
149
150 XXX
151
152 =back
153
154 =head1 Documentation
155
156 XXX Changes to files in F<pod/> go here.  Consider grouping entries by
157 file and be sure to link to the appropriate page, e.g. L<perlfunc>.
158
159 =head2 New Documentation
160
161 XXX Changes which create B<new> files in F<pod/> go here.
162
163 =head3 L<XXX>
164
165 XXX Description of the purpose of the new file here
166
167 =head2 Changes to Existing Documentation
168
169 We have attempted to update the documentation to reflect the changes
170 listed in this document.  If you find any we have missed, send email
171 to L<perlbug@perl.org|mailto:perlbug@perl.org>.
172
173 XXX Changes which significantly change existing files in F<pod/> go here.
174 However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
175 section.
176
177 Additionally, the following selected changes have been made:
178
179 =head3 L<XXX>
180
181 =over 4
182
183 =item *
184
185 XXX Description of the change here
186
187 =back
188
189 =head1 Diagnostics
190
191 The following additions or changes have been made to diagnostic output,
192 including warnings and fatal error messages.  For the complete list of
193 diagnostic messages, see L<perldiag>.
194
195 XXX New or changed warnings emitted by the core's C<C> code go here.  Also
196 include any changes in L<perldiag> that reconcile it to the C<C> code.
197
198 =head2 New Diagnostics
199
200 XXX Newly added diagnostic messages go under here, separated into New Errors
201 and New Warnings
202
203 =head3 New Errors
204
205 =over 4
206
207 =item *
208
209 XXX L<message|perldiag/"message">
210
211 =back
212
213 =head3 New Warnings
214
215 =over 4
216
217 =item *
218
219 XXX L<message|perldiag/"message">
220
221 =back
222
223 =head2 Changes to Existing Diagnostics
224
225 XXX Changes (i.e. rewording) of diagnostic messages go here
226
227 =over 4
228
229 =item *
230
231 XXX Describe change here
232
233 =back
234
235 =head1 Utility Changes
236
237 XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here.
238 Most of these are built within the directory F<utils>.
239
240 [ List utility changes as a =head2 entry for each utility and =item
241 entries for each change
242 Use L<XXX> with program names to get proper documentation linking. ]
243
244 =head2 L<XXX>
245
246 =over 4
247
248 =item *
249
250 XXX
251
252 =back
253
254 =head1 Configuration and Compilation
255
256 XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
257 go here.  Any other changes to the Perl build process should be listed here.
258 However, any platform-specific changes should be listed in the
259 L</Platform Support> section, instead.
260
261 [ List changes as an =item entry ].
262
263 =over 4
264
265 =item *
266
267 XXX
268
269 =back
270
271 =head1 Testing
272
273 XXX Any significant changes to the testing of a freshly built perl should be
274 listed here.  Changes which create B<new> files in F<t/> go here as do any
275 large changes to the testing harness (e.g. when parallel testing was added).
276 Changes to existing files in F<t/> aren't worth summarizing, although the bugs
277 that they represent may be covered elsewhere.
278
279 XXX If there were no significant test changes, say this:
280
281 Tests were added and changed to reflect the other additions and changes
282 in this release.
283
284 XXX If instead there were significant changes, say this:
285
286 Tests were added and changed to reflect the other additions and
287 changes in this release.  Furthermore, these significant changes were
288 made:
289
290 [ List each test improvement as an =item entry ]
291
292 =over 4
293
294 =item *
295
296 XXX
297
298 =back
299
300 =head1 Platform Support
301
302 XXX Any changes to platform support should be listed in the sections below.
303
304 [ Within the sections, list each platform as an =item entry with specific
305 changes as paragraphs below it. ]
306
307 =head2 New Platforms
308
309 XXX List any platforms that this version of perl compiles on, that previous
310 versions did not.  These will either be enabled by new files in the F<hints/>
311 directories, or new subdirectories and F<README> files at the top level of the
312 source tree.
313
314 =over 4
315
316 =item XXX-some-platform
317
318 XXX
319
320 =back
321
322 =head2 Discontinued Platforms
323
324 XXX List any platforms that this version of perl no longer compiles on.
325
326 =over 4
327
328 =item XXX-some-platform
329
330 XXX
331
332 =back
333
334 =head2 Platform-Specific Notes
335
336 XXX List any changes for specific platforms.  This could include configuration
337 and compilation changes or changes in portability/compatibility.  However,
338 changes within modules for platforms should generally be listed in the
339 L</Modules and Pragmata> section.
340
341 =over 4
342
343 =item Windows
344
345 =over 4
346
347 =item *
348
349 Support for compiling perl on Windows using Microsoft Visual Studio 2019
350 (containing Visual C++ 14.2) has been added.
351
352 =back
353
354 =back
355
356 =head1 Internal Changes
357
358 XXX Changes which affect the interface available to C<XS> code go here.  Other
359 significant internal changes for future core maintainers should be noted as
360 well.
361
362 [ List each change as an =item entry ]
363
364 =over 4
365
366 =item *
367
368 A new function L<perlapi/C<my_strtod>> or its synonym, Strtod(), is
369 now availabe with the same signature as the libc strtod().  It provides
370 strotod() equivalent behavior on all platforms, using the best available
371 precision, depending on platform capabilities and F<Configure> options,
372 while handling locale-related issues, such as if the radix character
373 should be a dot or comma.
374
375 =back
376
377 =head1 Selected Bug Fixes
378
379 XXX Important bug fixes in the core language are summarized here.  Bug fixes in
380 files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>.
381
382 [ List each fix as an =item entry ]
383
384 =over 4
385
386 =item *
387
388 Perl now exposes POSIX C<getcwd> as C<Internals::getcwd()> if
389 available.  This is intended for use by C<Cwd.pm> during bootstrapping
390 and may be removed or changed without notice.  This fixes some
391 bootstrapping issues while building perl in a directory where some
392 ancestor directory isn't readable.  [perl #133951]
393
394 =back
395
396 =head1 Known Problems
397
398 XXX Descriptions of platform agnostic bugs we know we can't fix go here.  Any
399 tests that had to be C<TODO>ed for the release would be noted here.  Unfixed
400 platform specific bugs also go here.
401
402 [ List each fix as an =item entry ]
403
404 =over 4
405
406 =item *
407
408 XXX
409
410 =back
411
412 =head1 Errata From Previous Releases
413
414 =over 4
415
416 =item *
417
418 The perldelta for 5.29.9 listed the enhancement about regular expression
419 lookbehind in the C<Security> section rather than the C<Core Enhancements>
420 section.  Its title should also have indicated that it is "Limited"
421 variable-length lookbehind (up to 255 characters).  (Note that a
422 technique has now been published to achieve arbitrary variable length
423 lookbehind with pre-existing Perl constructs and is linked to in L<perlre>.
424 It is 
425 L<http://www.drregex.com/2019/02/variable-length-lookbehinds-actually.html>.)
426
427 XXX Add anything here that we forgot to add, or were mistaken about, in
428 the perldelta of a previous release.
429
430 =back
431
432 =head1 Obituary
433
434 XXX If any significant core contributor or member of the CPAN community has
435 died, add a short obituary here.
436
437 =head1 Acknowledgements
438
439 XXX Generate this with:
440
441   perl Porting/acknowledgements.pl v5.29.9..HEAD
442
443 =head1 Reporting Bugs
444
445 If you find what you think is a bug, you might check the perl bug database
446 at L<https://rt.perl.org/>.  There may also be information at
447 L<http://www.perl.org/>, the Perl Home Page.
448
449 If you believe you have an unreported bug, please run the L<perlbug> program
450 included with your release.  Be sure to trim your bug down to a tiny but
451 sufficient test case.  Your bug report, along with the output of C<perl -V>,
452 will be sent off to perlbug@perl.org to be analysed by the Perl porting team.
453
454 If the bug you are reporting has security implications which make it
455 inappropriate to send to a publicly archived mailing list, then see
456 L<perlsec/SECURITY VULNERABILITY CONTACT INFORMATION>
457 for details of how to report the issue.
458
459 =head1 Give Thanks
460
461 If you wish to thank the Perl 5 Porters for the work we had done in Perl 5,
462 you can do so by running the C<perlthanks> program:
463
464     perlthanks
465
466 This will send an email to the Perl 5 Porters list with your show of thanks.
467
468 =head1 SEE ALSO
469
470 The F<Changes> file for an explanation of how to view exhaustive details on
471 what changed.
472
473 The F<INSTALL> file for how to build Perl.
474
475 The F<README> file for general stuff.
476
477 The F<Artistic> and F<Copying> files for copyright information.
478
479 =cut