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