This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
perldelta abda9fe0fe75ae824723761c1c98af958f17a41c
[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.27.7
9
10 =head1 DESCRIPTION
11
12 This document describes differences between the 5.27.6 release and the 5.27.7
13 release.
14
15 If you are upgrading from an earlier release such as 5.27.5, first read
16 L<perl5276delta>, which describes differences between 5.27.5 and 5.27.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 =head2  The C<sprintf> C<%j> format size modifier is now available with
31 pre-C99 compilers
32
33 The actual size used depends on the platform, so remains unportable.
34
35 =head1 Security
36
37 XXX Any security-related notices go here.  In particular, any security
38 vulnerabilities closed should be noted here rather than in the
39 L</Selected Bug Fixes> section.
40
41 [ List each security issue as a =head2 entry ]
42
43 =head1 Incompatible Changes
44
45 XXX For a release on a stable branch, this section aspires to be:
46
47     There are no changes intentionally incompatible with 5.XXX.XXX
48     If any exist, they are bugs, and we request that you submit a
49     report.  See L</Reporting Bugs> below.
50
51 [ List each incompatible change as a =head2 entry ]
52
53 =head1 Deprecations
54
55 XXX Any deprecated features, syntax, modules etc. should be listed here.
56
57 =head2 Assignment to C<$[> will be fatal in Perl 5.30
58
59 Assigning a non-zero value to L<C<$[>|perlvar/$[> has been deprecated
60 since Perl 5.12, but was never given a deadline for removal.  This has
61 now been scheduled for Perl 5.30.
62
63 =head2 Module removals
64
65 XXX Remove this section if not applicable.
66
67 The following modules will be removed from the core distribution in a
68 future release, and will at that time need to be installed from CPAN.
69 Distributions on CPAN which require these modules will need to list them as
70 prerequisites.
71
72 The core versions of these modules will now issue C<"deprecated">-category
73 warnings to alert you to this fact.  To silence these deprecation warnings,
74 install the modules in question from CPAN.
75
76 Note that these are (with rare exceptions) fine modules that you are encouraged
77 to continue to use.  Their disinclusion from core primarily hinges on their
78 necessity to bootstrapping a fully functional, CPAN-capable Perl installation,
79 not usually on concerns over their design.
80
81 =over
82
83 =item L<Locale::Codes> and its associated Country, Currency and Language modules
84
85 XXX Note that deprecated modules should be listed here even if they are listed
86 as an updated module in the L</Modules and Pragmata> section.
87
88 =back
89
90 [ List each other deprecation as a =head2 entry ]
91
92 =head1 Performance Enhancements
93
94 XXX Changes which enhance performance without changing behaviour go here.
95 There may well be none in a stable release.
96
97 [ List each enhancement as an =item entry ]
98
99 =over 4
100
101 =item *
102
103 XXX
104
105 =back
106
107 =head1 Modules and Pragmata
108
109 XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
110 go here.  If Module::CoreList is updated, generate an initial draft of the
111 following sections using F<Porting/corelist-perldelta.pl>.  A paragraph summary
112 for important changes should then be added by hand.  In an ideal world,
113 dual-life modules would have a F<Changes> file that could be cribbed.
114
115 The list of new and updated modules is modified automatically as part of
116 preparing a Perl release, so the only reason to manually add entries here is if
117 you're summarising the important changes in the module update. (Also, if the
118 manually-added details don't match the automatically-generated ones, the
119 release manager will have to investigate the situation carefully.)
120
121 [ Within each section, list entries as an =item entry ]
122
123 =head2 New Modules and Pragmata
124
125 =over 4
126
127 =item *
128
129 XXX Remove this section if not applicable.
130
131 =back
132
133 =head2 Updated Modules and Pragmata
134
135 =over 4
136
137 =item *
138
139 L<Locale::Codes> has been upgraded from version 3.54 to 3.55
140
141 B<NOTE>: L<Locale::Codes> is deprecated in core and will be removed
142 from Perl 5.30.
143
144 =item *
145
146 L<Data::Dumper> has been upgraded from version 2.167_02 to 2.168.
147 Quoting of glob names now obeys the Useqq option [perl #119831].
148
149 =back
150
151 =head2 Removed Modules and Pragmata
152
153 =over 4
154
155 =item *
156
157 XXX
158
159 =back
160
161 =head1 Documentation
162
163 XXX Changes to files in F<pod/> go here.  Consider grouping entries by
164 file and be sure to link to the appropriate page, e.g. L<perlfunc>.
165
166 =head2 New Documentation
167
168 XXX Changes which create B<new> files in F<pod/> go here.
169
170 =head3 L<XXX>
171
172 XXX Description of the purpose of the new file here
173
174 =head2 Changes to Existing Documentation
175
176 We have attempted to update the documentation to reflect the changes
177 listed in this document.  If you find any we have missed, send email
178 to L<perlbug@perl.org|mailto:perlbug@perl.org>.
179
180 XXX Changes which significantly change existing files in F<pod/> go here.
181 However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
182 section.
183
184 Additionally, the following selected changes have been made:
185
186 =head3 L<perlapi>
187
188 The documentation of C<newGIVENOP()> has been belatedly updated to
189 account for the removal of lexical C<$_>.
190
191 =head3 L<perluniprops>
192
193 For each binary table or property, the documentation now includes which
194 characters in the range C<\x00-\xFF> it matches, as well as a list of
195 the first few ranges of code points matched above that.
196
197 =over 4
198
199 =item *
200
201 XXX Description of the change here
202
203 =back
204
205 =head1 Diagnostics
206
207 The following additions or changes have been made to diagnostic output,
208 including warnings and fatal error messages.  For the complete list of
209 diagnostic messages, see L<perldiag>.
210
211 XXX New or changed warnings emitted by the core's C<C> code go here.  Also
212 include any changes in L<perldiag> that reconcile it to the C<C> code.
213
214 =head2 New Diagnostics
215
216 XXX Newly added diagnostic messages go under here, separated into New Errors
217 and New Warnings
218
219 =head3 New Errors
220
221 =over 4
222
223 =item *
224
225 L<Can't "goto" into a "given" block|perldiag/"Can't E<quot>gotoE<quot> into a E<quot>givenE<quot> block">
226
227 (F) A "goto" statement was executed to jump into the middle of a C<given>
228 block.  You can't get there from here.  See L<perlfunc/goto>.
229
230 =back
231
232 =head3 New Warnings
233
234 =over 4
235
236 =item *
237
238 L<Old package separator used in string|perldiag/"Old package separator used in string">
239
240 (W syntax) You used the old package separator, "'", in a variable
241 named inside a double-quoted string; e.g., C<"In $name's house">.  This
242 is equivalent to C<"In $name::s house">.  If you meant the former, put
243 a backslash before the apostrophe (C<"In $name\'s house">).
244
245 =back
246
247 =head2 Changes to Existing Diagnostics
248
249 XXX Changes (i.e. rewording) of diagnostic messages go here
250
251 =over 4
252
253 =item *
254
255 XXX Describe change here
256
257 =item *
258
259 Warnings that a variable or subroutine "masks earlier declaration in same
260 ...", or that an C<our> variable has been redeclared, have been moved to a
261 new warnings category "shadow".  Previously they were in category "misc".
262
263 =back
264
265 =head1 Utility Changes
266
267 XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here.
268 Most of these are built within the directory F<utils>.
269
270 [ List utility changes as a =head2 entry for each utility and =item
271 entries for each change
272 Use L<XXX> with program names to get proper documentation linking. ]
273
274 =head2 L<XXX>
275
276 =over 4
277
278 =item *
279
280 XXX
281
282 =back
283
284 =head1 Configuration and Compilation
285
286 XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
287 go here.  Any other changes to the Perl build process should be listed here.
288 However, any platform-specific changes should be listed in the
289 L</Platform Support> section, instead.
290
291 [ List changes as an =item entry ].
292
293 =over 4
294
295 =item *
296
297 XXX
298
299 =back
300
301 =head1 Testing
302
303 XXX Any significant changes to the testing of a freshly built perl should be
304 listed here.  Changes which create B<new> files in F<t/> go here as do any
305 large changes to the testing harness (e.g. when parallel testing was added).
306 Changes to existing files in F<t/> aren't worth summarizing, although the bugs
307 that they represent may be covered elsewhere.
308
309 XXX If there were no significant test changes, say this:
310
311 Tests were added and changed to reflect the other additions and changes
312 in this release.
313
314 XXX If instead there were significant changes, say this:
315
316 Tests were added and changed to reflect the other additions and
317 changes in this release.  Furthermore, these significant changes were
318 made:
319
320 [ List each test improvement as an =item entry ]
321
322 =over 4
323
324 =item *
325
326 XXX
327
328 =back
329
330 =head1 Platform Support
331
332 XXX Any changes to platform support should be listed in the sections below.
333
334 [ Within the sections, list each platform as an =item entry with specific
335 changes as paragraphs below it. ]
336
337 =head2 New Platforms
338
339 XXX List any platforms that this version of perl compiles on, that previous
340 versions did not.  These will either be enabled by new files in the F<hints/>
341 directories, or new subdirectories and F<README> files at the top level of the
342 source tree.
343
344 =over 4
345
346 =item XXX-some-platform
347
348 XXX
349
350 =back
351
352 =head2 Discontinued Platforms
353
354 XXX List any platforms that this version of perl no longer compiles on.
355
356 =over 4
357
358 =item XXX-some-platform
359
360 XXX
361
362 =back
363
364 =head2 Platform-Specific Notes
365
366 XXX List any changes for specific platforms.  This could include configuration
367 and compilation changes or changes in portability/compatibility.  However,
368 changes within modules for platforms should generally be listed in the
369 L</Modules and Pragmata> section.
370
371 =over 4
372
373 =item Windows
374
375 We now set C<$Config{libpth}> correctly for 64-bit builds using Visual C++
376 versions earlier than 14.1.
377
378 =back
379
380 =head1 Internal Changes
381
382 XXX Changes which affect the interface available to C<XS> code go here.  Other
383 significant internal changes for future core maintainers should be noted as
384 well.
385
386 =over 4
387
388 =item *
389
390 XS modules can now automatically get reentrant versions of system
391 functions on threaded perls.
392
393 By saying
394
395  #define PERL_REENTRANT
396
397 near the beginning of an C<XS> file, it will be compiled so that
398 whatever reentrant functions perl knows about on that system will
399 automatically and invisibly be used instead of the plain, non-reentrant
400 versions.  For example, if you write C<getpwnam()> in your code, on a
401 system that has C<pwnam_r()> all calls to the former will be translated
402 invisibly into the latter.  This does not happen except on threaded
403 perls, as they aren't needed otherwise.  Be aware that which functions
404 have reentrant versions varies from system to system.
405
406 =back
407
408 =head1 Selected Bug Fixes
409
410 XXX Important bug fixes in the core language are summarized here.  Bug fixes in
411 files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>.
412
413 [ List each fix as an =item entry ]
414
415 =over 4
416
417 =item *
418
419 XXX
420
421 =item *
422
423 Perl's own C<malloc> no longer gets confused by attempts to allocate
424 more than a gigabyte on a 64-bit platform.  [perl #119829]
425
426 =item *
427
428 C<open $$scalarref...> and similar invocations no longer leak the file
429 handle.  [perl #115814]
430
431 =item *
432
433 The default typemap, by avoiding C<newGVgen>, now no longer leaks when
434 XSUBs return file handles (C<PerlIO *> or C<FILE *>).  [perl #115814]
435
436 =back
437
438 =head1 Known Problems
439
440 XXX Descriptions of platform agnostic bugs we know we can't fix go here.  Any
441 tests that had to be C<TODO>ed for the release would be noted here.  Unfixed
442 platform specific bugs also go here.
443
444 [ List each fix as an =item entry ]
445
446 =over 4
447
448 =item *
449
450 XXX
451
452 =back
453
454 =head1 Errata From Previous Releases
455
456 =over 4
457
458 =item *
459
460 XXX Add anything here that we forgot to add, or were mistaken about, in
461 the perldelta of a previous release.
462
463 =back
464
465 =head1 Obituary
466
467 XXX If any significant core contributor or member of the CPAN community has
468 died, add a short obituary here.
469
470 =head1 Acknowledgements
471
472 XXX Generate this with:
473
474   perl Porting/acknowledgements.pl v5.27.6..HEAD
475
476 =head1 Reporting Bugs
477
478 If you find what you think is a bug, you might check the perl bug database
479 at L<https://rt.perl.org/> .  There may also be information at
480 L<http://www.perl.org/> , the Perl Home Page.
481
482 If you believe you have an unreported bug, please run the L<perlbug> program
483 included with your release.  Be sure to trim your bug down to a tiny but
484 sufficient test case.  Your bug report, along with the output of C<perl -V>,
485 will be sent off to perlbug@perl.org to be analysed by the Perl porting team.
486
487 If the bug you are reporting has security implications which make it
488 inappropriate to send to a publicly archived mailing list, then see
489 L<perlsec/SECURITY VULNERABILITY CONTACT INFORMATION>
490 for details of how to report the issue.
491
492 =head1 Give Thanks
493
494 If you wish to thank the Perl 5 Porters for the work we had done in Perl 5,
495 you can do so by running the C<perlthanks> program:
496
497     perlthanks
498
499 This will send an email to the Perl 5 Porters list with your show of thanks.
500
501 =head1 SEE ALSO
502
503 The F<Changes> file for an explanation of how to view exhaustive details on
504 what changed.
505
506 The F<INSTALL> file for how to build Perl.
507
508 The F<README> file for general stuff.
509
510 The F<Artistic> and F<Copying> files for copyright information.
511
512 =cut