This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Optimize out unicode_to_native(), native_to_unicode()
[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.21.10
9
10 =head1 DESCRIPTION
11
12 This document describes differences between the 5.21.9 release and the 5.21.10
13 release.
14
15 If you are upgrading from an earlier release such as 5.21.8, first read
16 L<perl5219delta>, which describes differences between 5.21.8 and 5.21.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 [ List each enhancement as a =head2 entry ]
29
30 =head1 Security
31
32 XXX Any security-related notices go here.  In particular, any security
33 vulnerabilities closed should be noted here rather than in the
34 L</Selected Bug Fixes> section.
35
36 [ List each security issue as a =head2 entry ]
37
38 =head1 Incompatible Changes
39
40 XXX For a release on a stable branch, this section aspires to be:
41
42     There are no changes intentionally incompatible with 5.XXX.XXX
43     If any exist, they are bugs, and we request that you submit a
44     report.  See L</Reporting Bugs> below.
45
46 [ List each incompatible change as a =head2 entry ]
47
48 =head1 Deprecations
49
50 XXX Any deprecated features, syntax, modules etc. should be listed here.
51
52 =head2 Module removals
53
54 XXX Remove this section if inapplicable.
55
56 The following modules will be removed from the core distribution in a
57 future release, and will at that time need to be installed from CPAN.
58 Distributions on CPAN which require these modules will need to list them as
59 prerequisites.
60
61 The core versions of these modules will now issue C<"deprecated">-category
62 warnings to alert you to this fact.  To silence these deprecation warnings,
63 install the modules in question from CPAN.
64
65 Note that these are (with rare exceptions) fine modules that you are encouraged
66 to continue to use.  Their disinclusion from core primarily hinges on their
67 necessity to bootstrapping a fully functional, CPAN-capable Perl installation,
68 not usually on concerns over their design.
69
70 =over
71
72 =item XXX
73
74 XXX Note that deprecated modules should be listed here even if they are listed
75 as an updated module in the L</Modules and Pragmata> section.
76
77 =back
78
79 [ List each other deprecation as a =head2 entry ]
80
81 =head1 Performance Enhancements
82
83 XXX Changes which enhance performance without changing behaviour go here.
84 There may well be none in a stable release.
85
86 [ List each enhancement as a =item entry ]
87
88 =over 4
89
90 =item *
91
92 The functions
93 C<utf8::native_to_unicode()> and
94 C<utf8::unicode_to_native()> (see L<utf8>)
95 are now optimized out on ASCII platforms.
96 There is now not even a minimal performance hit in writing code portable
97 between ASCII and EBCDIC platforms.
98
99 =back
100
101 =head1 Modules and Pragmata
102
103 XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
104 go here.  If Module::CoreList is updated, generate an initial draft of the
105 following sections using F<Porting/corelist-perldelta.pl>.  A paragraph summary
106 for important changes should then be added by hand.  In an ideal world,
107 dual-life modules would have a F<Changes> file that could be cribbed.
108
109 [ Within each section, list entries as a =item entry ]
110
111 =head2 New Modules and Pragmata
112
113 =over 4
114
115 =item *
116
117 XXX
118
119 =back
120
121 =head2 Updated Modules and Pragmata
122
123 =over 4
124
125 =item *
126
127 L<B::Deparse> has been upgraded from version 1.33 to 1.34.
128
129 Deparse C<$#_> as that instead of as C<$#{_}>.  [perl #123947]
130
131 =item *
132
133 L<CPAN> has been upgraded from version 2.05 to 2.09-TRIAL.
134
135 =over 4
136
137 =item *
138
139 Add support for C<Cwd::getdcwd()> and introduce workaround for a misbehaviour
140 seen on Strawberry Perl 5.20.1.
141
142 =item *
143
144 Fix C<chdir()> after building dependencies bug.
145
146 =item *
147
148 Introduce experimental support for plugins/hooks.
149
150 =item *
151
152 Integrate the App::Cpan sources.
153
154 =item *
155
156 Do not check recursion on optional dependencies.
157
158 =item *
159
160 Sanity check META.yml to contain a hash.
161 L<[cpan #95271]|https://rt.cpan.org/Ticket/Display.html?id=95271>
162
163 =back
164
165 =item *
166
167 L<Test::Simple> has been reverted from version 1.301001_098 to 1.001014.
168
169 =item *
170
171 L<Text::Balanced> has been upgraded from version 2.02 to 2.03.
172
173 No changes to installed files other than the version bump.
174
175 =item *
176
177 L<threads> has been upgraded from version 1.96 to 1.99.
178
179 =back
180
181 =head2 Removed Modules and Pragmata
182
183 =over 4
184
185 =item *
186
187 XXX
188
189 =back
190
191 =head1 Documentation
192
193 XXX Changes to files in F<pod/> go here.  Consider grouping entries by
194 file and be sure to link to the appropriate page, e.g. L<perlfunc>.
195
196 =head2 New Documentation
197
198 XXX Changes which create B<new> files in F<pod/> go here.
199
200 =head3 L<XXX>
201
202 XXX Description of the purpose of the new file here
203
204 =head2 Changes to Existing Documentation
205
206 XXX Changes which significantly change existing files in F<pod/> go here.
207 However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
208 section.
209
210 =head3 L<XXX>
211
212 =over 4
213
214 =item *
215
216 XXX Description of the change here
217
218 =back
219
220 =head1 Diagnostics
221
222 The following additions or changes have been made to diagnostic output,
223 including warnings and fatal error messages.  For the complete list of
224 diagnostic messages, see L<perldiag>.
225
226 XXX New or changed warnings emitted by the core's C<C> code go here.  Also
227 include any changes in L<perldiag> that reconcile it to the C<C> code.
228
229 =head2 New Diagnostics
230
231 XXX Newly added diagnostic messages go under here, separated into New Errors
232 and New Warnings
233
234 =head3 New Errors
235
236 =over 4
237
238 =item *
239
240 XXX L<message|perldiag/"message">
241
242 =back
243
244 =head3 New Warnings
245
246 =over 4
247
248 =item *
249
250 XXX L<message|perldiag/"message">
251
252 =back
253
254 =head2 Changes to Existing Diagnostics
255
256 XXX Changes (i.e. rewording) of diagnostic messages go here
257
258 =over 4
259
260 =item *
261
262 XXX Describe change here
263
264 =back
265
266 =head1 Utility Changes
267
268 XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here.
269 Most of these are built within the directory F<utils>.
270
271 [ List utility changes as a =head2 entry for each utility and =item
272 entries for each change
273 Use L<XXX> with program names to get proper documentation linking. ]
274
275 =head2 L<XXX>
276
277 =over 4
278
279 =item *
280
281 XXX
282
283 =back
284
285 =head1 Configuration and Compilation
286
287 XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
288 go here.  Any other changes to the Perl build process should be listed here.
289 However, any platform-specific changes should be listed in the
290 L</Platform Support> section, instead.
291
292 [ List changes as a =item entry ].
293
294 =over 4
295
296 =item *
297
298 XXX
299
300 =back
301
302 =head1 Testing
303
304 XXX Any significant changes to the testing of a freshly built perl should be
305 listed here.  Changes which create B<new> files in F<t/> go here as do any
306 large changes to the testing harness (e.g. when parallel testing was added).
307 Changes to existing files in F<t/> aren't worth summarizing, although the bugs
308 that they represent may be covered elsewhere.
309
310 [ List each test improvement as a =item entry ]
311
312 =over 4
313
314 =item *
315
316 XXX
317
318 =back
319
320 =head1 Platform Support
321
322 XXX Any changes to platform support should be listed in the sections below.
323
324 [ Within the sections, list each platform as a =item entry with specific
325 changes as paragraphs below it. ]
326
327 =head2 New Platforms
328
329 XXX List any platforms that this version of perl compiles on, that previous
330 versions did not.  These will either be enabled by new files in the F<hints/>
331 directories, or new subdirectories and F<README> files at the top level of the
332 source tree.
333
334 =over 4
335
336 =item XXX-some-platform
337
338 XXX
339
340 =back
341
342 =head2 Discontinued Platforms
343
344 XXX List any platforms that this version of perl no longer compiles on.
345
346 =over 4
347
348 =item XXX-some-platform
349
350 XXX
351
352 =back
353
354 =head2 Platform-Specific Notes
355
356 XXX List any changes for specific platforms.  This could include configuration
357 and compilation changes or changes in portability/compatibility.  However,
358 changes within modules for platforms should generally be listed in the
359 L</Modules and Pragmata> section.
360
361 =over 4
362
363 =item XXX-some-platform
364
365 XXX
366
367 =back
368
369 =head1 Internal Changes
370
371 XXX Changes which affect the interface available to C<XS> code go here.  Other
372 significant internal changes for future core maintainers should be noted as
373 well.
374
375 [ List each change as a =item entry ]
376
377 =over 4
378
379 =item *
380
381 XXX
382
383 =back
384
385 =head1 Selected Bug Fixes
386
387 XXX Important bug fixes in the core language are summarized here.  Bug fixes in
388 files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>.
389
390 [ List each fix as a =item entry ]
391
392 =over 4
393
394 =item *
395
396 Repeated global pattern matches in scalar context on large tainted
397 strings were exponentially slow depending on the current match
398 position in the string. [perl #123202]
399
400 =back
401
402 =head1 Known Problems
403
404 XXX Descriptions of platform agnostic bugs we know we can't fix go here.  Any
405 tests that had to be C<TODO>ed for the release would be noted here.  Unfixed
406 platform specific bugs also go here.
407
408 [ List each fix as a =item entry ]
409
410 =over 4
411
412 =item *
413
414 XXX
415
416 =back
417
418 =head1 Errata From Previous Releases
419
420 =over 4
421
422 =item *
423
424 XXX Add anything here that we forgot to add, or were mistaken about, in
425 the perldelta of a previous release.
426
427 =back
428
429 =head1 Obituary
430
431 XXX If any significant core contributor has died, we've added a short obituary
432 here.
433
434 =head1 Acknowledgements
435
436 XXX Generate this with:
437
438   perl Porting/acknowledgements.pl v5.21.9..HEAD
439
440 =head1 Reporting Bugs
441
442 If you find what you think is a bug, you might check the articles recently
443 posted to the comp.lang.perl.misc newsgroup and the perl bug database at
444 https://rt.perl.org/ .  There may also be information at
445 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 please send it
454 to perl5-security-report@perl.org.  This points to a closed subscription
455 unarchived mailing list, which includes all the core committers, who will be
456 able to help assess the impact of issues, figure out a resolution, and help
457 co-ordinate the release of patches to mitigate or fix the problem across all
458 platforms on which Perl is supported.  Please only use this address for
459 security issues in the Perl core, not for modules independently distributed on
460 CPAN.
461
462 =head1 SEE ALSO
463
464 The F<Changes> file for an explanation of how to view exhaustive details on
465 what changed.
466
467 The F<INSTALL> file for how to build Perl.
468
469 The F<README> file for general stuff.
470
471 The F<Artistic> and F<Copying> files for copyright information.
472
473 =cut