This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
126ea55eb3d960a4240f238eacbdbba8648e407e
[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.4
9
10 =head1 DESCRIPTION
11
12 This document describes differences between the 5.23.3 release and the 5.23.4
13 release.
14
15 If you are upgrading from an earlier release such as 5.23.2, first read
16 L<perl5233delta>, which describes differences between 5.23.2 and 5.23.3.
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 Lexical $_ has been removed
41
42 C<my $_> was introduced in Perl v5.10, and subsequently caused much confusion
43 with no obvious solution.  In Perl v5.18.0, it was made experimental on the
44 theory that it would either be removed or redesigned in a less confusing (but
45 backward-incompatible) way.  Over the following years, no alternatives were
46 proposed.  The feature has now been removed and will fail to compile.
47
48 =head2 Only blanks and tabs are now allowed within C<[...]> within C<(?[...])>.
49
50 The experimental Extended Bracketed Character Classes can contain
51 regular bracketed character classes within them.  These differ from
52 regular ones in that white space is generally ignored, unless escaped by
53 preceding it with a backslash.  The white space that is ignored is now
54 limited to just tab C<\t> and SPACE characters.  Previously, it was any
55 white space.  See
56 L<perlrecharclass/Extended Bracketed Character Classes>.
57
58 =head1 Deprecations
59
60 XXX Any deprecated features, syntax, modules etc. should be listed here.
61
62 =head2 Module removals
63
64 XXX Remove this section if inapplicable.
65
66 The following modules will be removed from the core distribution in a
67 future release, and will at that time need to be installed from CPAN.
68 Distributions on CPAN which require these modules will need to list them as
69 prerequisites.
70
71 The core versions of these modules will now issue C<"deprecated">-category
72 warnings to alert you to this fact.  To silence these deprecation warnings,
73 install the modules in question from CPAN.
74
75 Note that these are (with rare exceptions) fine modules that you are encouraged
76 to continue to use.  Their disinclusion from core primarily hinges on their
77 necessity to bootstrapping a fully functional, CPAN-capable Perl installation,
78 not usually on concerns over their design.
79
80 =over
81
82 =item XXX
83
84 XXX Note that deprecated modules should be listed here even if they are listed
85 as an updated module in the L</Modules and Pragmata> section.
86
87 =back
88
89 [ List each other deprecation as a =head2 entry ]
90
91 =head1 Performance Enhancements
92
93 XXX Changes which enhance performance without changing behaviour go here.
94 There may well be none in a stable release.
95
96 [ List each enhancement as a =item entry ]
97
98 =over 4
99
100 =item *
101
102 XXX
103
104 =back
105
106 =head1 Modules and Pragmata
107
108 XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
109 go here.  If Module::CoreList is updated, generate an initial draft of the
110 following sections using F<Porting/corelist-perldelta.pl>.  A paragraph summary
111 for important changes should then be added by hand.  In an ideal world,
112 dual-life modules would have a F<Changes> file that could be cribbed.
113
114 [ Within each section, list entries as a =item entry ]
115
116 =head2 New Modules and Pragmata
117
118 =over 4
119
120 =item *
121
122 XXX
123
124 =back
125
126 =head2 Updated Modules and Pragmata
127
128 =over 4
129
130 =item *
131
132 L<XXX> has been upgraded from version A.xx to B.yy.
133
134 =back
135
136 =head2 Removed Modules and Pragmata
137
138 =over 4
139
140 =item *
141
142 XXX
143
144 =back
145
146 =head1 Documentation
147
148 XXX Changes to files in F<pod/> go here.  Consider grouping entries by
149 file and be sure to link to the appropriate page, e.g. L<perlfunc>.
150
151 =head2 New Documentation
152
153 XXX Changes which create B<new> files in F<pod/> go here.
154
155 =head3 L<XXX>
156
157 XXX Description of the purpose of the new file here
158
159 =head2 Changes to Existing Documentation
160
161 XXX Changes which significantly change existing files in F<pod/> go here.
162 However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
163 section.
164
165 =head3 L<XXX>
166
167 =over 4
168
169 =item *
170
171 XXX Description of the change here
172
173 =back
174
175 =head1 Diagnostics
176
177 The following additions or changes have been made to diagnostic output,
178 including warnings and fatal error messages.  For the complete list of
179 diagnostic messages, see L<perldiag>.
180
181 XXX New or changed warnings emitted by the core's C<C> code go here.  Also
182 include any changes in L<perldiag> that reconcile it to the C<C> code.
183
184 =head2 New Diagnostics
185
186 XXX Newly added diagnostic messages go under here, separated into New Errors
187 and New Warnings
188
189 =head3 New Errors
190
191 =over 4
192
193 =item *
194
195 L<Character following \p must be '{' or a single-character Unicode property name in regex;|perldiag/"Character following \%c must be '{' or a single-character Unicode property name in regex; marked by <-- HERE in m/%s/">
196
197 =item *
198
199 L<perldiag/"Illegal user-defined property name">
200
201 =back
202
203 =head3 New Warnings
204
205 =over 4
206
207 =item *
208
209 XXX L<message|perldiag/"message">
210
211 =back
212
213 =head2 Changes to Existing Diagnostics
214
215 XXX Changes (i.e. rewording) of diagnostic messages go here
216
217 =over 4
218
219 =item *
220
221 L<"Can't modify non-lvalue subroutine call of &%s"|perldiag/"Can't modify non-lvalue subroutine call of &%s">
222
223 This error now reports the name of the non-lvalue subroutine you
224 attempted to use as an lvalue.
225
226 =back
227
228 =head1 Utility Changes
229
230 XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here.
231 Most of these are built within the directory F<utils>.
232
233 [ List utility changes as a =head2 entry for each utility and =item
234 entries for each change
235 Use L<XXX> with program names to get proper documentation linking. ]
236
237 =head2 L<XXX>
238
239 =over 4
240
241 =item *
242
243 Using the C<NO_HASH_SEED> define in combination with the default hash algorithm
244 C<PERL_HASH_FUNC_ONE_AT_A_TIME_HARD> resulted in a fatal error while compiling
245 the interpreter, since 5.17.10. This has been fixed.
246
247 =back
248
249 =head1 Configuration and Compilation
250
251 XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
252 go here.  Any other changes to the Perl build process should be listed here.
253 However, any platform-specific changes should be listed in the
254 L</Platform Support> section, instead.
255
256 [ List changes as a =item entry ].
257
258 =over 4
259
260 =item *
261
262 XXX
263
264 =back
265
266 =head1 Testing
267
268 XXX Any significant changes to the testing of a freshly built perl should be
269 listed here.  Changes which create B<new> files in F<t/> go here as do any
270 large changes to the testing harness (e.g. when parallel testing was added).
271 Changes to existing files in F<t/> aren't worth summarizing, although the bugs
272 that they represent may be covered elsewhere.
273
274 [ List each test improvement as a =item entry ]
275
276 =over 4
277
278 =item *
279
280 XXX
281
282 =back
283
284 =head1 Platform Support
285
286 XXX Any changes to platform support should be listed in the sections below.
287
288 [ Within the sections, list each platform as a =item entry with specific
289 changes as paragraphs below it. ]
290
291 =head2 New Platforms
292
293 XXX List any platforms that this version of perl compiles on, that previous
294 versions did not.  These will either be enabled by new files in the F<hints/>
295 directories, or new subdirectories and F<README> files at the top level of the
296 source tree.
297
298 =over 4
299
300 =item XXX-some-platform
301
302 XXX
303
304 =back
305
306 =head2 Discontinued Platforms
307
308 XXX List any platforms that this version of perl no longer compiles on.
309
310 =over 4
311
312 =item XXX-some-platform
313
314 XXX
315
316 =back
317
318 =head2 Platform-Specific Notes
319
320 XXX List any changes for specific platforms.  This could include configuration
321 and compilation changes or changes in portability/compatibility.  However,
322 changes within modules for platforms should generally be listed in the
323 L</Modules and Pragmata> section.
324
325 =over 4
326
327 =item XXX-some-platform
328
329 XXX
330
331 =item Win32
332
333 =over
334
335 =item *
336
337 A new build option C<USE_NO_REGISTRY> has been added to the makefiles.  This
338 option is off by default, meaning the default is to do Windows registry lookups.
339 This option stops Perl from looking inside the registry for anything.  For what
340 values are looked up in the registry see L<perlwin32>.  Internally, in C, the
341 name of this option is C<WIN32_NO_REGISTRY>.
342
343 =item *
344
345 The behavior of Perl using C<HKEY_CURRENT_USER\Software\Perl> and
346 C<HKEY_LOCAL_MACHINE\Software\Perl> to lookup certain values, including
347 C<%ENV> vars starting with C<PERL> has changed.  Previously, the 2 keys were
348 checked for entries at all times through Perl processes life time even if they
349 did not exist.  For performance reasons, now, if the root key (i.e.
350 C<HKEY_CURRENT_USER\Software\Perl> or C<HKEY_LOCAL_MACHINE\Software\Perl>) does
351 not exist at process start time, it will not be checked again for C<%ENV>
352 override entries for the remainder of the Perl processes life.  This more
353 closely matches Unix behaviour in that the enviroment is copied or inherited on
354 startup and changing the variable in the parent process or another process or
355 editing <.bashrc> will not change the enviromental variable in other existing,
356 running, processes.
357
358 =item *
359
360 One glob fetch was removed for each C<-X> or C<stat> call whether done from
361 Perl code or internally from Perl's C code. The glob being looked up was
362 C<${^WIN32_SLOPPY_STAT}> which is a special variable. This makes C<-X> and
363 C<stat> slightly faster.
364
365 =item *
366
367 During Miniperl's process startup, during the build process, 4 to 8 IO calls
368 related to the process starting C<.pl> and the C<buildcustomize.pl> file were
369 removed from the code opening and executing the first 1 or 2 C<.pl> files.
370
371 =back
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 [ List each change as a =item entry ]
382
383 =over 4
384
385 =item *
386
387 L<perlapi/sv_backoff> had its return type changed fron C<int> to C<void>.  It
388 previously has always returned C<0> since 5.000 stable but that was
389 undocumented.  Although C<sv_backoff> is marked as public API, XS code is not
390 expected to be impacted since the proper API call would be through public API
391 C<sv_setsv(sv, &PL_sv_undef)>, or quasi-public C<SvOOK_off>, or non-public
392 C<SvOK_off> calls, and the return value of C<sv_backoff> was previously a
393 meaningless constant that can be rewritten as C<(sv_backoff(sv),0)>.
394
395 =item *
396
397 The C<EXTEND> and C<MEXTEND> macros have been improved to avoid various
398 issues with integer truncation and wrapping. In particular, some casts
399 formerly used within the macros have been removed. This means for example
400 that passing an unsigned nitems arg is likely to raise a compiler warning
401 now (it's always been documented to require a signed value; formerly int,
402 lately SSize_t).
403
404 =item *
405
406 (This was actually done in v5.23.2, but the perldelta entry got missed.)
407 The way that C<OP_AASSIGN> handles assignment with potentially common
408 values (e.g. C<($a,$b) = ($b, $a)> has changed. In particular the
409 C<OPpASSIGN_COMMON> flag has been replaced with three more specific flags:
410
411     OPpASSIGN_COMMON_AGG
412     OPpASSIGN_COMMON_RC1
413     OPpASSIGN_COMMON_SCALAR
414
415 and the runtime now sometimes does a mark and sweep using the C<SVf_BREAK>
416 to detect common elements.
417
418 =back
419
420 =head1 Selected Bug Fixes
421
422 XXX Important bug fixes in the core language are summarized here.  Bug fixes in
423 files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>.
424
425 [ List each fix as a =item entry ]
426
427 =over 4
428
429 =item *
430
431 There were places in regular expression patterns where comments
432 (C<(?#...)>) weren't allowed, but should have been.  This is now fixed.
433 [perl #116639]
434
435 =item *
436
437 A regression from perl v5.20 has been fixed, in which some syntax errors
438 in L<C<(?[...])>|perlrecharclass/Extended Bracketed Character Classes>
439 constructs within regular expression patterns could cause a segfault
440 instead of a proper error message.  [perl #126180]
441
442 =item *
443
444 Some problems with attempting to extend the perl stack to around 2G or 4G
445 entries have been fixed. This was particularly an issue on 32-bit perls
446 built to use 64-bit integers, and was easily noticeable with the list
447 repetition operator, e.g.
448
449     @a = (1) x $big_number
450
451 Formerly perl may have crashed, depending on the exact value of
452 $big_number; now it will typically raise an exception.
453 [perl #125937]
454
455 =back
456
457 =head1 Known Problems
458
459 XXX Descriptions of platform agnostic bugs we know we can't fix go here.  Any
460 tests that had to be C<TODO>ed for the release would be noted here.  Unfixed
461 platform specific bugs also go here.
462
463 [ List each fix as a =item entry ]
464
465 =over 4
466
467 =item *
468
469 XXX
470
471 =back
472
473 =head1 Errata From Previous Releases
474
475 =over 4
476
477 =item *
478
479 XXX Add anything here that we forgot to add, or were mistaken about, in
480 the perldelta of a previous release.
481
482 =back
483
484 =head1 Obituary
485
486 XXX If any significant core contributor has died, we've added a short obituary
487 here.
488
489 =head1 Acknowledgements
490
491 XXX Generate this with:
492
493   perl Porting/acknowledgements.pl v5.23.3..HEAD
494
495 =head1 Reporting Bugs
496
497 If you find what you think is a bug, you might check the articles recently
498 posted to the comp.lang.perl.misc newsgroup and the perl bug database at
499 L<https://rt.perl.org/> .  There may also be information at
500 L<http://www.perl.org/> , the Perl Home Page.
501
502 If you believe you have an unreported bug, please run the L<perlbug> program
503 included with your release.  Be sure to trim your bug down to a tiny but
504 sufficient test case.  Your bug report, along with the output of C<perl -V>,
505 will be sent off to perlbug@perl.org to be analysed by the Perl porting team.
506
507 If the bug you are reporting has security implications, which make it
508 inappropriate to send to a publicly archived mailing list, then please send it
509 to perl5-security-report@perl.org.  This points to a closed subscription
510 unarchived mailing list, which includes all the core committers, who will be
511 able to help assess the impact of issues, figure out a resolution, and help
512 co-ordinate the release of patches to mitigate or fix the problem across all
513 platforms on which Perl is supported.  Please only use this address for
514 security issues in the Perl core, not for modules independently distributed on
515 CPAN.
516
517 =head1 SEE ALSO
518
519 The F<Changes> file for an explanation of how to view exhaustive details on
520 what changed.
521
522 The F<INSTALL> file for how to build Perl.
523
524 The F<README> file for general stuff.
525
526 The F<Artistic> and F<Copying> files for copyright information.
527
528 =cut