This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
perldelta for e8c18a8486f7
[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.23.6
9
10 =head1 DESCRIPTION
11
12 This document describes differences between the 5.23.5 release and the 5.23.6
13 release.
14
15 If you are upgrading from an earlier release such as 5.23.4, first read
16 L<perl5235delta>, which describes differences between 5.23.4 and 5.23.5.
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 =head2 Some regular expression patterns that had runtime errors now
41 don't compile at all
42
43 This should have been in the perldelta for 5.23.4, but was omitted.
44
45 Almost all Unicode properties using the C<\p{}> and C<\P{}> regular
46 expression pattern constructs are now checked for validity at pattern
47 compilation time, and invalid ones will cause the program to not
48 compile.  In earlier releases, this check was often deferred until run
49 time.  Whenever an error check is moved from run- to compile time,
50 erroneous code is caught 100% of the time, whereas before it would only
51 get caught if and when the offending portion actually gets executed,
52 which for unreachable code might be never.
53
54 =head1 Deprecations
55
56 XXX Any deprecated features, syntax, modules etc. should be listed here.
57
58 =head2 Module removals
59
60 XXX Remove this section if inapplicable.
61
62 The following modules will be removed from the core distribution in a
63 future release, and will at that time need to be installed from CPAN.
64 Distributions on CPAN which require these modules will need to list them as
65 prerequisites.
66
67 The core versions of these modules will now issue C<"deprecated">-category
68 warnings to alert you to this fact.  To silence these deprecation warnings,
69 install the modules in question from CPAN.
70
71 Note that these are (with rare exceptions) fine modules that you are encouraged
72 to continue to use.  Their disinclusion from core primarily hinges on their
73 necessity to bootstrapping a fully functional, CPAN-capable Perl installation,
74 not usually on concerns over their design.
75
76 =over
77
78 =item XXX
79
80 XXX Note that deprecated modules should be listed here even if they are listed
81 as an updated module in the L</Modules and Pragmata> section.
82
83 =back
84
85 [ List each other deprecation as a =head2 entry ]
86
87 =head2 Using code points above the platform's C<IV_MAX> is now
88 deprecated
89
90 Unicode defines code points in the range C<0..0x10FFFF>.  Some standards
91 at one time defined them up to 2**31 - 1, but Perl has allowed them to
92 be as high as anything that will fit in a word on the platform being
93 used.  However, use of those above the platform's C<IV_MAX> is broken in
94 some constructs, notably C<tr///>, regular expression patterns involving
95 quantifiers, and in some arithmetic and comparison operations, such as
96 being the upper limit of a loop.  Now the use of such code points raises
97 a deprecation warning, unless that warning category is turned off.
98 C<IV_MAX> is typically 2**31 -1 on 32-bit platforms, and 2**63-1 on
99 64-bit ones.
100
101 =head1 Performance Enhancements
102
103 XXX Changes which enhance performance without changing behaviour go here.
104 There may well be none in a stable release.
105
106 [ List each enhancement as a =item entry ]
107
108 =over 4
109
110 =item *
111
112 XXX
113
114 =back
115
116 =head1 Modules and Pragmata
117
118 XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
119 go here.  If Module::CoreList is updated, generate an initial draft of the
120 following sections using F<Porting/corelist-perldelta.pl>.  A paragraph summary
121 for important changes should then be added by hand.  In an ideal world,
122 dual-life modules would have a F<Changes> file that could be cribbed.
123
124 [ Within each section, list entries as a =item entry ]
125
126 =head2 New Modules and Pragmata
127
128 =over 4
129
130 =item *
131
132 XXX
133
134 =back
135
136 =head2 Updated Modules and Pragmata
137
138 =over 4
139
140 =item *
141
142 L<XXX> has been upgraded from version A.xx to B.yy.
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 XXX Changes which significantly change existing files in F<pod/> go here.
172 However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
173 section.
174
175 =head3 L<XXX>
176
177 =over 4
178
179 =item *
180
181 XXX Description of the change here
182
183 =back
184
185 =head1 Diagnostics
186
187 The following additions or changes have been made to diagnostic output,
188 including warnings and fatal error messages.  For the complete list of
189 diagnostic messages, see L<perldiag>.
190
191 XXX New or changed warnings emitted by the core's C<C> code go here.  Also
192 include any changes in L<perldiag> that reconcile it to the C<C> code.
193
194 =head2 New Diagnostics
195
196 XXX Newly added diagnostic messages go under here, separated into New Errors
197 and New Warnings
198
199 =head3 New Errors
200
201 =over 4
202
203 =item *
204
205 L<message|perldiag/"Invalid number '%s' for -C option.">
206
207 (F) You supplied a number to the -C option that either has extra leading
208 zeroes or overflows perl's unsigned integer representation.
209
210
211 =back
212
213 =head3 New Warnings
214
215 =over 4
216
217 =item *
218
219 XXX L<message|perldiag/"message">
220
221 =back
222
223 =head2 Changes to Existing Diagnostics
224
225 XXX Changes (i.e. rewording) of diagnostic messages go here
226
227 =over 4
228
229 =item *
230
231 XXX Describe change here
232
233 =back
234
235 =head1 Utility Changes
236
237 XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here.
238 Most of these are built within the directory F<utils>.
239
240 [ List utility changes as a =head2 entry for each utility and =item
241 entries for each change
242 Use L<XXX> with program names to get proper documentation linking. ]
243
244 =head2 L<XXX>
245
246 =over 4
247
248 =item *
249
250 XXX
251
252 =back
253
254 =head1 Configuration and Compilation
255
256 XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
257 go here.  Any other changes to the Perl build process should be listed here.
258 However, any platform-specific changes should be listed in the
259 L</Platform Support> section, instead.
260
261 [ List changes as a =item entry ].
262
263 =over 4
264
265 =item *
266
267 F<make_ext.pl> is no longer inappropriately silent.  This was caused
268 by an operator precedence error introduced in 5.23.4.
269
270 =back
271
272 =head1 Testing
273
274 XXX Any significant changes to the testing of a freshly built perl should be
275 listed here.  Changes which create B<new> files in F<t/> go here as do any
276 large changes to the testing harness (e.g. when parallel testing was added).
277 Changes to existing files in F<t/> aren't worth summarizing, although the bugs
278 that they represent may be covered elsewhere.
279
280 [ List each test improvement as a =item entry ]
281
282 =over 4
283
284 =item *
285
286 XXX
287
288 =back
289
290 =head1 Platform Support
291
292 XXX Any changes to platform support should be listed in the sections below.
293
294 [ Within the sections, list each platform as a =item entry with specific
295 changes as paragraphs below it. ]
296
297 =head2 New Platforms
298
299 XXX List any platforms that this version of perl compiles on, that previous
300 versions did not.  These will either be enabled by new files in the F<hints/>
301 directories, or new subdirectories and F<README> files at the top level of the
302 source tree.
303
304 =over 4
305
306 =item XXX-some-platform
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 EBCDIC platforms, such as z/OS
334
335 UTF-EBCDIC is like UTF-8, but for EBCDIC platforms.  It now has been
336 extended so that it can represent code points up to 2 ** 64 - 1 on
337 platforms with 64-bit words.  This brings it into parity with UTF-8.
338 This enhancement requires an incompatible change to the representation
339 of code points in the range 2 ** 30 to 2 ** 31 -1 (the latter was the
340 previous maximum representable code point).  This means that a file that
341 contains one of these code points, written out with previous versions of
342 perl cannot be read in, without conversion, by a perl containing this
343 change.  We do not believe any such files are in existence, but if you
344 do have one, submit a ticket at L<mailto:perlbug@perl.org>, and we will
345 write a conversion script for you.
346
347 =back
348
349 =head1 Internal Changes
350
351 XXX Changes which affect the interface available to C<XS> code go here.  Other
352 significant internal changes for future core maintainers should be noted as
353 well.
354
355 [ List each change as a =item entry ]
356
357 =over 4
358
359 =item *
360
361 XXX
362
363 =back
364
365 =head1 Selected Bug Fixes
366
367 XXX Important bug fixes in the core language are summarized here.  Bug fixes in
368 files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>.
369
370 [ List each fix as a =item entry ]
371
372 =over 4
373
374 =item *
375
376 C</...\G/> no longer crashes on utf8 strings. When C<\G> is a fixed number
377 of characters from the start of the regex, perl needs to count back that
378 many characters from the current C<pos()> position and start matching from
379 there. However, it was counting back bytes rather than characters, which
380 could lead to panics on utf8 strings.
381
382 =item *
383
384 In some cases operators that return integers would return negative
385 integers as large positive integers.  [perl #126635]
386
387 =item *
388
389 The pipe() operator would assert for DEBUGGING builds instead of
390 producing the correct error message.  The condition asserted on is
391 detected and reported on correctly without the assertions, so the
392 assertions were removed.  [perl #126480]
393
394 =back
395
396 =head1 Known Problems
397
398 XXX Descriptions of platform agnostic bugs we know we can't fix go here.  Any
399 tests that had to be C<TODO>ed for the release would be noted here.  Unfixed
400 platform specific bugs also go here.
401
402 [ List each fix as a =item entry ]
403
404 =over 4
405
406 =item *
407
408 XXX
409
410 =back
411
412 =head1 Errata From Previous Releases
413
414 =over 4
415
416 =item *
417
418 XXX Add anything here that we forgot to add, or were mistaken about, in
419 the perldelta of a previous release.
420
421 =back
422
423 =head1 Obituary
424
425 XXX If any significant core contributor has died, we've added a short obituary
426 here.
427
428 =head1 Acknowledgements
429
430 XXX Generate this with:
431
432   perl Porting/acknowledgements.pl v5.23.5..HEAD
433
434 =head1 Reporting Bugs
435
436 If you find what you think is a bug, you might check the articles recently
437 posted to the comp.lang.perl.misc newsgroup and the perl bug database at
438 L<https://rt.perl.org/> .  There may also be information at
439 L<http://www.perl.org/> , the Perl Home Page.
440
441 If you believe you have an unreported bug, please run the L<perlbug> program
442 included with your release.  Be sure to trim your bug down to a tiny but
443 sufficient test case.  Your bug report, along with the output of C<perl -V>,
444 will be sent off to perlbug@perl.org to be analysed by the Perl porting team.
445
446 If the bug you are reporting has security implications, which make it
447 inappropriate to send to a publicly archived mailing list, then please send it
448 to perl5-security-report@perl.org.  This points to a closed subscription
449 unarchived mailing list, which includes all the core committers, who will be
450 able to help assess the impact of issues, figure out a resolution, and help
451 co-ordinate the release of patches to mitigate or fix the problem across all
452 platforms on which Perl is supported.  Please only use this address for
453 security issues in the Perl core, not for modules independently distributed on
454 CPAN.
455
456 =head1 SEE ALSO
457
458 The F<Changes> file for an explanation of how to view exhaustive details on
459 what changed.
460
461 The F<INSTALL> file for how to build Perl.
462
463 The F<README> file for general stuff.
464
465 The F<Artistic> and F<Copying> files for copyright information.
466
467 =cut