This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Change enum names for new locale function parameters
[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.10
9
10 =head1 DESCRIPTION
11
12 This document describes differences between the 5.27.9 release and the 5.27.10
13 release.
14
15 If you are upgrading from an earlier release such as 5.27.8, first read
16 L<perl5279delta>, which describes differences between 5.27.8 and 5.27.9.
17
18 =head1 Notice
19
20 XXX Any important notices here
21
22 =head1 Core Enhancements
23
24 =head2 XXX
25
26 XXX
27
28 =head1 Security
29
30 XXX Any security-related notices go here.  In particular, any security
31 vulnerabilities closed should be noted here rather than in the
32 L</Selected Bug Fixes> section.
33
34 [ List each security issue as a =head2 entry ]
35
36 =head1 Incompatible Changes
37
38 XXX For a release on a stable branch, this section aspires to be:
39
40     There are no changes intentionally incompatible with 5.XXX.XXX
41     If any exist, they are bugs, and we request that you submit a
42     report.  See L</Reporting Bugs> below.
43
44 [ List each incompatible change as a =head2 entry ]
45
46 =head1 Deprecations
47
48 XXX Any deprecated features, syntax, modules etc. should be listed here.
49
50 =head2 Module removals
51
52 XXX Remove this section if not applicable.
53
54 The following modules will be removed from the core distribution in a
55 future release, and will at that time need to be installed from CPAN.
56 Distributions on CPAN which require these modules will need to list them as
57 prerequisites.
58
59 The core versions of these modules will now issue C<"deprecated">-category
60 warnings to alert you to this fact.  To silence these deprecation warnings,
61 install the modules in question from CPAN.
62
63 Note that these are (with rare exceptions) fine modules that you are encouraged
64 to continue to use.  Their disinclusion from core primarily hinges on their
65 necessity to bootstrapping a fully functional, CPAN-capable Perl installation,
66 not usually on concerns over their design.
67
68 =over
69
70 =item XXX
71
72 XXX Note that deprecated modules should be listed here even if they are listed
73 as an updated module in the L</Modules and Pragmata> section.
74
75 =back
76
77 [ List each other deprecation as a =head2 entry ]
78
79 =head1 Performance Enhancements
80
81 =over 4
82
83 =item *
84
85 XXX
86
87 =back
88
89 =head1 Modules and Pragmata
90
91 XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
92 go here.  If Module::CoreList is updated, generate an initial draft of the
93 following sections using F<Porting/corelist-perldelta.pl>.  A paragraph summary
94 for important changes should then be added by hand.  In an ideal world,
95 dual-life modules would have a F<Changes> file that could be cribbed.
96
97 The list of new and updated modules is modified automatically as part of
98 preparing a Perl release, so the only reason to manually add entries here is if
99 you're summarising the important changes in the module update. (Also, if the
100 manually-added details don't match the automatically-generated ones, the
101 release manager will have to investigate the situation carefully.)
102
103 [ Within each section, list entries as an =item entry ]
104
105 =head2 New Modules and Pragmata
106
107 =over 4
108
109 =item *
110
111 XXX Remove this section if not applicable.
112
113 =back
114
115 =head2 Updated Modules and Pragmata
116
117 =over 4
118
119 =item *
120
121 L<Carp> has been upgraded from version 1.46 to 1.4x.
122
123 XXX Please update the version number.
124
125 L<Carp>, when generating stack traces, now attempts to work around
126 longstanding bugs resulting from Perl's non-reference-counted stack.
127 [perl #52610]
128
129 Carp has been modified to avoid assuming that objects cannot be
130 overloaded without the L<overload> module loaded (this can happen with
131 objects created by XS modules).  Previously, infinite recursion would
132 result if an XS-defined overload method itself called Carp.  [perl #132828]
133
134 Carp now avoids using C<overload::StrVal>, partly because older versions
135 of L<overload> (included with perl 5.14 and earlier) load L<Scalar::Util>
136 at run time, which will fail if Carp has been invoked after a syntax error.
137
138 =back
139
140 =head2 Removed Modules and Pragmata
141
142 =over 4
143
144 =item *
145
146 XXX
147
148 =back
149
150 =head1 Documentation
151
152 XXX Changes to files in F<pod/> go here.  Consider grouping entries by
153 file and be sure to link to the appropriate page, e.g. L<perlfunc>.
154
155 =head2 New Documentation
156
157 XXX Changes which create B<new> files in F<pod/> go here.
158
159 =head3 L<XXX>
160
161 XXX Description of the purpose of the new file here
162
163 =head2 Changes to Existing Documentation
164
165 XXX Changes which significantly change existing files in F<pod/> go here.
166 However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
167 section.
168
169 Additionally, the following selected changes have been made:
170
171 =head3 L<XXX>
172
173 =over 4
174
175 =item *
176
177 XXX Description of the change here
178
179 =back
180
181 =head1 Diagnostics
182
183 The following additions or changes have been made to diagnostic output,
184 including warnings and fatal error messages.  For the complete list of
185 diagnostic messages, see L<perldiag>.
186
187 XXX New or changed warnings emitted by the core's C<C> code go here.  Also
188 include any changes in L<perldiag> that reconcile it to the C<C> code.
189
190 =head2 New Diagnostics
191
192 XXX Newly added diagnostic messages go under here, separated into New Errors
193 and New Warnings
194
195 =head3 New Errors
196
197 =over 4
198
199 =item *
200
201 XXX L<message|perldiag/"message">
202
203 =back
204
205 =head3 New Warnings
206
207 =over 4
208
209 =item *
210
211 XXX
212
213 =back
214
215 =head2 Changes to Existing Diagnostics
216
217 XXX Changes (i.e. rewording) of diagnostic messages go here
218
219 =over 4
220
221 =item *
222
223 The new (as of 5.27.8) restriction forbidding use of C<goto> to enter the
224 argument of a binary or list expression (see L<perldiag/"Can't
225 E<quot>gotoE<quot> into a binary or list expression">) has been relaxed to
226 allow entering the I<first> argument of an operator that takes a fixed
227 number of arguments, since this is a case that will not cause stack
228 corruption.  [perl #132854]
229
230 =item *
231
232 The warning added in 5.27.8 concerning UTF-8 locale compatibility was
233 misleading.  The new wording and explanation are at
234 L<perldiag/Locale '%s' contains (at least) the following characters which
235 have unexepected meanings: %s  The Perl program will use the exepected
236 meanings>
237
238 =back
239
240 =head1 Utility Changes
241
242 XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here.
243 Most of these are built within the directory F<utils>.
244
245 [ List utility changes as a =head2 entry for each utility and =item
246 entries for each change
247 Use L<XXX> with program names to get proper documentation linking. ]
248
249 =head2 L<XXX>
250
251 =over 4
252
253 =item *
254
255 XXX
256
257 =back
258
259 =head1 Configuration and Compilation
260
261 XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
262 go here.  Any other changes to the Perl build process should be listed here.
263 However, any platform-specific changes should be listed in the
264 L</Platform Support> section, instead.
265
266 [ List changes as an =item entry ].
267
268 =over 4
269
270 =item *
271
272 F<lib/unicore/mktables> now correctly canonicalizes the names of the
273 dependencies stored in the files it generates.
274
275 F<regen/mk_invlists.pl>, unlike the other F<regen/*.pl> scripts, used
276 C<$0> to name itself in the dependencies stored in the files it
277 generates.  It now uses a literal so that the path stored in the
278 generated files doesn't depend on how F<regen/mk_invlists.pl> is
279 invoked.
280
281 This lack of canonical names could cause test failures in
282 F<t/porting/regen.t>.  [perl #132925]
283
284 =back
285
286 =head1 Testing
287
288 Tests were added and changed to reflect the other additions and
289 changes in this release.  Furthermore, these significant changes were
290 made:
291
292 =over 4
293
294 =item *
295
296 XXX
297
298 =back
299
300 =head1 Platform Support
301
302 =head2 New Platforms
303
304 =over 4
305
306 =item That Plaftorm
307
308 XXX
309
310 =back
311
312 =head2 Discontinued Platforms
313
314 XXX List any platforms that this version of perl no longer compiles on.
315
316 =over 4
317
318 =item XXX-some-platform
319
320 XXX
321
322 =back
323
324 =head2 Platform-Specific Notes
325
326 XXX List any changes for specific platforms.  This could include configuration
327 and compilation changes or changes in portability/compatibility.  However,
328 changes within modules for platforms should generally be listed in the
329 L</Modules and Pragmata> section.
330
331 =over 4
332
333 =item XXX-some-platform
334
335 XXX
336
337 =back
338
339 =head1 Internal Changes
340
341 =over 4
342
343 =item *
344
345 The item names passed to the function L<perlapi/Perl_langinfo>,
346 introduced in 5.27.4, may no longer be prefixed with C<PERL_>.  For
347 example, if you want the current floating point radix character, you
348 must call it like C<Perl_langinfo(RADIXCHAR)>.
349
350 =back
351
352 =head1 Selected Bug Fixes
353
354 =over 4
355
356 =item *
357
358 XXX
359
360 =back
361
362 =head1 Known Problems
363
364 XXX Descriptions of platform agnostic bugs we know we can't fix go here.  Any
365 tests that had to be C<TODO>ed for the release would be noted here.  Unfixed
366 platform specific bugs also go here.
367
368 [ List each fix as an =item entry ]
369
370 =over 4
371
372 =item *
373
374 XXX
375
376 =back
377
378 =head1 Errata From Previous Releases
379
380 =over 4
381
382 =item *
383
384 XXX Add anything here that we forgot to add, or were mistaken about, in
385 the perldelta of a previous release.
386
387 =back
388
389 =head1 Obituary
390
391 XXX If any significant core contributor or member of the CPAN community has
392 died, add a short obituary here.
393
394 =head1 Acknowledgements
395
396 XXX Generate this with:
397
398   perl Porting/acknowledgements.pl v5.27.9..HEAD
399
400 =head1 Reporting Bugs
401
402 If you find what you think is a bug, you might check the perl bug database
403 at L<https://rt.perl.org/> .  There may also be information at
404 L<http://www.perl.org/> , the Perl Home Page.
405
406 If you believe you have an unreported bug, please run the L<perlbug> program
407 included with your release.  Be sure to trim your bug down to a tiny but
408 sufficient test case.  Your bug report, along with the output of C<perl -V>,
409 will be sent off to perlbug@perl.org to be analysed by the Perl porting team.
410
411 If the bug you are reporting has security implications which make it
412 inappropriate to send to a publicly archived mailing list, then see
413 L<perlsec/SECURITY VULNERABILITY CONTACT INFORMATION>
414 for details of how to report the issue.
415
416 =head1 Give Thanks
417
418 If you wish to thank the Perl 5 Porters for the work we had done in Perl 5,
419 you can do so by running the C<perlthanks> program:
420
421     perlthanks
422
423 This will send an email to the Perl 5 Porters list with your show of thanks.
424
425 =head1 SEE ALSO
426
427 The F<Changes> file for an explanation of how to view exhaustive details on
428 what changed.
429
430 The F<INSTALL> file for how to build Perl.
431
432 The F<README> file for general stuff.
433
434 The F<Artistic> and F<Copying> files for copyright information.
435
436 =cut