This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
edeba324ac1cf9f18ac85aba704f5ae9a1684868
[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 =back
145
146 =head2 Removed Modules and Pragmata
147
148 =over 4
149
150 =item *
151
152 XXX
153
154 =back
155
156 =head1 Documentation
157
158 XXX Changes to files in F<pod/> go here.  Consider grouping entries by
159 file and be sure to link to the appropriate page, e.g. L<perlfunc>.
160
161 =head2 New Documentation
162
163 XXX Changes which create B<new> files in F<pod/> go here.
164
165 =head3 L<XXX>
166
167 XXX Description of the purpose of the new file here
168
169 =head2 Changes to Existing Documentation
170
171 We have attempted to update the documentation to reflect the changes
172 listed in this document.  If you find any we have missed, send email
173 to L<perlbug@perl.org|mailto:perlbug@perl.org>.
174
175 XXX Changes which significantly change existing files in F<pod/> go here.
176 However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
177 section.
178
179 Additionally, the following selected changes have been made:
180
181 =head3 L<perlapi>
182
183 The documentation of C<newGIVENOP()> has been belatedly updated to
184 account for the removal of lexical C<$_>.
185
186 =head3 L<perluniprops>
187
188 For each binary table or property, the documentation now includes which
189 characters in the range C<\x00-\xFF> it matches, as well as a list of
190 the first few ranges of code points matched above that.
191
192 =over 4
193
194 =item *
195
196 XXX Description of the change here
197
198 =back
199
200 =head1 Diagnostics
201
202 The following additions or changes have been made to diagnostic output,
203 including warnings and fatal error messages.  For the complete list of
204 diagnostic messages, see L<perldiag>.
205
206 XXX New or changed warnings emitted by the core's C<C> code go here.  Also
207 include any changes in L<perldiag> that reconcile it to the C<C> code.
208
209 =head2 New Diagnostics
210
211 XXX Newly added diagnostic messages go under here, separated into New Errors
212 and New Warnings
213
214 =head3 New Errors
215
216 =over 4
217
218 =item *
219
220 L<Can't "goto" into a "given" block|perldiag/"Can't E<quot>gotoE<quot> into a E<quot>givenE<quot> block">
221
222 (F) A "goto" statement was executed to jump into the middle of a C<given>
223 block.  You can't get there from here.  See L<perlfunc/goto>.
224
225 =back
226
227 =head3 New Warnings
228
229 =over 4
230
231 =item *
232
233 L<Old package separator used in string|perldiag/"Old package separator used in string">
234
235 (W syntax) You used the old package separator, "'", in a variable
236 named inside a double-quoted string; e.g., C<"In $name's house">.  This
237 is equivalent to C<"In $name::s house">.  If you meant the former, put
238 a backslash before the apostrophe (C<"In $name\'s house">).
239
240 =back
241
242 =head2 Changes to Existing Diagnostics
243
244 XXX Changes (i.e. rewording) of diagnostic messages go here
245
246 =over 4
247
248 =item *
249
250 XXX Describe change here
251
252 =item *
253
254 Warnings that a variable or subroutine "masks earlier declaration in same
255 ...", or that an C<our> variable has been redeclared, have been moved to a
256 new warnings category "shadow".  Previously they were in category "misc".
257
258 =back
259
260 =head1 Utility Changes
261
262 XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here.
263 Most of these are built within the directory F<utils>.
264
265 [ List utility changes as a =head2 entry for each utility and =item
266 entries for each change
267 Use L<XXX> with program names to get proper documentation linking. ]
268
269 =head2 L<XXX>
270
271 =over 4
272
273 =item *
274
275 XXX
276
277 =back
278
279 =head1 Configuration and Compilation
280
281 XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
282 go here.  Any other changes to the Perl build process should be listed here.
283 However, any platform-specific changes should be listed in the
284 L</Platform Support> section, instead.
285
286 [ List changes as an =item entry ].
287
288 =over 4
289
290 =item *
291
292 XXX
293
294 =back
295
296 =head1 Testing
297
298 XXX Any significant changes to the testing of a freshly built perl should be
299 listed here.  Changes which create B<new> files in F<t/> go here as do any
300 large changes to the testing harness (e.g. when parallel testing was added).
301 Changes to existing files in F<t/> aren't worth summarizing, although the bugs
302 that they represent may be covered elsewhere.
303
304 XXX If there were no significant test changes, say this:
305
306 Tests were added and changed to reflect the other additions and changes
307 in this release.
308
309 XXX If instead there were significant changes, say this:
310
311 Tests were added and changed to reflect the other additions and
312 changes in this release.  Furthermore, these significant changes were
313 made:
314
315 [ List each test improvement as an =item entry ]
316
317 =over 4
318
319 =item *
320
321 XXX
322
323 =back
324
325 =head1 Platform Support
326
327 XXX Any changes to platform support should be listed in the sections below.
328
329 [ Within the sections, list each platform as an =item entry with specific
330 changes as paragraphs below it. ]
331
332 =head2 New Platforms
333
334 XXX List any platforms that this version of perl compiles on, that previous
335 versions did not.  These will either be enabled by new files in the F<hints/>
336 directories, or new subdirectories and F<README> files at the top level of the
337 source tree.
338
339 =over 4
340
341 =item XXX-some-platform
342
343 XXX
344
345 =back
346
347 =head2 Discontinued Platforms
348
349 XXX List any platforms that this version of perl no longer compiles on.
350
351 =over 4
352
353 =item XXX-some-platform
354
355 XXX
356
357 =back
358
359 =head2 Platform-Specific Notes
360
361 XXX List any changes for specific platforms.  This could include configuration
362 and compilation changes or changes in portability/compatibility.  However,
363 changes within modules for platforms should generally be listed in the
364 L</Modules and Pragmata> section.
365
366 =over 4
367
368 =item Windows
369
370 We now set C<$Config{libpth}> correctly for 64-bit builds using Visual C++
371 versions earlier than 14.1.
372
373 =back
374
375 =head1 Internal Changes
376
377 XXX Changes which affect the interface available to C<XS> code go here.  Other
378 significant internal changes for future core maintainers should be noted as
379 well.
380
381 =over 4
382
383 =item *
384
385 XS modules can now automatically get reentrant versions of system
386 functions on threaded perls.
387
388 By saying
389
390  #define PERL_REENTRANT
391
392 near the beginning of an C<XS> file, it will be compiled so that
393 whatever reentrant functions perl knows about on that system will
394 automatically and invisibly be used instead of the plain, non-reentrant
395 versions.  For example, if you write C<getpwnam()> in your code, on a
396 system that has C<pwnam_r()> all calls to the former will be translated
397 invisibly into the latter.  This does not happen except on threaded
398 perls, as they aren't needed otherwise.  Be aware that which functions
399 have reentrant versions varies from system to system.
400
401 =back
402
403 =head1 Selected Bug Fixes
404
405 XXX Important bug fixes in the core language are summarized here.  Bug fixes in
406 files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>.
407
408 [ List each fix as an =item entry ]
409
410 =over 4
411
412 =item *
413
414 XXX
415
416 =item *
417
418 Perl's own C<malloc> no longer gets confused by attempts to allocate
419 more than a gigabyte on a 64-bit platform.  [perl #119829]
420
421 =item *
422
423 C<open $$scalarref...> and similar invocations no longer leak the file
424 handle.  [perl #115814]
425
426 =item *
427
428 The default typemap, by avoiding C<newGVgen>, now no longer leaks when
429 XSUBs return file handles (C<PerlIO *> or C<FILE *>).  [perl #115814]
430
431 =back
432
433 =head1 Known Problems
434
435 XXX Descriptions of platform agnostic bugs we know we can't fix go here.  Any
436 tests that had to be C<TODO>ed for the release would be noted here.  Unfixed
437 platform specific bugs also go here.
438
439 [ List each fix as an =item entry ]
440
441 =over 4
442
443 =item *
444
445 XXX
446
447 =back
448
449 =head1 Errata From Previous Releases
450
451 =over 4
452
453 =item *
454
455 XXX Add anything here that we forgot to add, or were mistaken about, in
456 the perldelta of a previous release.
457
458 =back
459
460 =head1 Obituary
461
462 XXX If any significant core contributor or member of the CPAN community has
463 died, add a short obituary here.
464
465 =head1 Acknowledgements
466
467 XXX Generate this with:
468
469   perl Porting/acknowledgements.pl v5.27.6..HEAD
470
471 =head1 Reporting Bugs
472
473 If you find what you think is a bug, you might check the perl bug database
474 at L<https://rt.perl.org/> .  There may also be information at
475 L<http://www.perl.org/> , the Perl Home Page.
476
477 If you believe you have an unreported bug, please run the L<perlbug> program
478 included with your release.  Be sure to trim your bug down to a tiny but
479 sufficient test case.  Your bug report, along with the output of C<perl -V>,
480 will be sent off to perlbug@perl.org to be analysed by the Perl porting team.
481
482 If the bug you are reporting has security implications which make it
483 inappropriate to send to a publicly archived mailing list, then see
484 L<perlsec/SECURITY VULNERABILITY CONTACT INFORMATION>
485 for details of how to report the issue.
486
487 =head1 Give Thanks
488
489 If you wish to thank the Perl 5 Porters for the work we had done in Perl 5,
490 you can do so by running the C<perlthanks> program:
491
492     perlthanks
493
494 This will send an email to the Perl 5 Porters list with your show of thanks.
495
496 =head1 SEE ALSO
497
498 The F<Changes> file for an explanation of how to view exhaustive details on
499 what changed.
500
501 The F<INSTALL> file for how to build Perl.
502
503 The F<README> file for general stuff.
504
505 The F<Artistic> and F<Copying> files for copyright information.
506
507 =cut