This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
c7613e02b109ed467d2ac576c7f5bf8a7e20a22e
[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.33.1
9
10 =head1 DESCRIPTION
11
12 This document describes differences between the 5.33.0 release and the 5.33.1
13 release.
14
15 If you are upgrading from an earlier release such as 5.32.0, first read
16 L<perl5330delta>, which describes differences between 5.32.0 and 5.33.0.
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 not applicable.
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 an =item entry ]
87
88 =over 4
89
90 =item *
91
92 XXX
93
94 =back
95
96 =head1 Modules and Pragmata
97
98 XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
99 go here.  If Module::CoreList is updated, generate an initial draft of the
100 following sections using F<Porting/corelist-perldelta.pl>.  A paragraph summary
101 for important changes should then be added by hand.  In an ideal world,
102 dual-life modules would have a F<Changes> file that could be cribbed.
103
104 The list of new and updated modules is modified automatically as part of
105 preparing a Perl release, so the only reason to manually add entries here is if
106 you're summarising the important changes in the module update. (Also, if the
107 manually-added details don't match the automatically-generated ones, the
108 release manager will have to investigate the situation carefully.)
109
110 [ Within each section, list entries as an =item entry ]
111
112 =head2 New Modules and Pragmata
113
114 =over 4
115
116 =item * ExtUtils::PL2Bat
117
118 This module is a generalization of the pl2bat script. It being a script has lead
119 to at least two forks of this code, this modules will unify them under one
120 implemention with tests.
121
122 =back
123
124 =head2 Updated Modules and Pragmata
125
126 =over 4
127
128 =item *
129
130 L<feature> has been upgraded from version 1.58 to 1.60.
131
132 A new C<multidimensional> feature has been added, which is enabled by
133 default but allows turning off L<multi-dimensional array
134 emulation|perldata/Multi-dimensional array emulation>.
135
136 =back
137
138 =head2 Removed Modules and Pragmata
139
140 =over 4
141
142 =item *
143
144 XXX
145
146 =back
147
148 =head1 Documentation
149
150 XXX Changes to files in F<pod/> go here.  Consider grouping entries by
151 file and be sure to link to the appropriate page, e.g. L<perlfunc>.
152
153 =head2 New Documentation
154
155 XXX Changes which create B<new> files in F<pod/> go here.
156
157 =head3 L<XXX>
158
159 XXX Description of the purpose of the new file here
160
161 =head2 Changes to Existing Documentation
162
163 We have attempted to update the documentation to reflect the changes
164 listed in this document.  If you find any we have missed, open an issue
165 at L<https://github.com/Perl/perl5/issues>.
166
167 XXX Changes which significantly change existing files in F<pod/> go here.
168 However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
169 section.
170
171 Additionally, the following selected changes have been made:
172
173 =head3 L<perlpacktut>
174
175 =over 4
176
177 =item *
178
179 Incorrect variables used in an example have been fixed. Thanks to Deji Adegbite.
180
181 =back
182
183 =head3 L<perlfunc>
184
185 =over 4
186
187 =item *
188
189 Better explain what happens when C<sleep> is called with a zero or
190 negative value
191
192 =back
193
194 =head3 L<perlop>
195
196 =over 4
197
198 The C<< <> >> and C<<< <<>> >>> operators are commonly referred to as
199 the diamond and double diamond operators respectively, but that wasn't
200 mentioned previously in their documentation.
201
202 =back
203
204 =head1 Diagnostics
205
206 The following additions or changes have been made to diagnostic output,
207 including warnings and fatal error messages.  For the complete list of
208 diagnostic messages, see L<perldiag>.
209
210 XXX New or changed warnings emitted by the core's C<C> code go here.  Also
211 include any changes in L<perldiag> that reconcile it to the C<C> code.
212
213 =head2 New Diagnostics
214
215 XXX Newly added diagnostic messages go under here, separated into New Errors
216 and New Warnings
217
218 =head3 New Errors
219
220 =over 4
221
222 =item *
223
224 XXX L<message|perldiag/"message">
225
226 =back
227
228 =head3 New Warnings
229
230 =over 4
231
232 =item *
233
234 XXX L<message|perldiag/"message">
235
236 =back
237
238 =head2 Changes to Existing Diagnostics
239
240 XXX Changes (i.e. rewording) of diagnostic messages go here
241
242 =over 4
243
244 =item *
245
246 XXX Describe change here
247
248 =back
249
250 =head1 Utility Changes
251
252 XXX Changes to installed programs such as F<perldoc> and F<xsubpp> go here.
253 Most of these are built within the directory F<utils>.
254
255 [ List utility changes as a =head2 entry for each utility and =item
256 entries for each change
257 Use L<XXX> with program names to get proper documentation linking. ]
258
259 =head2 L<perl5db.pl> (the debugger)
260
261 =over 4
262
263 =item * New option: C<HistItemMinLength>
264
265 This option controls the minimum length a command must be to get stored in
266 history.  Traditionally, this has been fixed at 2.  Changes to the debugger
267 are often perilous, and new bugs should be reported so the debugger can be
268 debugged.
269
270 =item * Fix to C<i> and C<l> commands
271
272 The C<i $var> and C<l $var> commands work again with lexical variables.
273
274 =back
275
276 =head1 Configuration and Compilation
277
278 XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
279 go here.  Any other changes to the Perl build process should be listed here.
280 However, any platform-specific changes should be listed in the
281 L</Platform Support> section, instead.
282
283 [ List changes as an =item entry ].
284
285 =over 4
286
287 =item *
288
289 The minimum supported Bison version is now 2.4, and the maxiumm is 3.7.
290
291 =back
292
293 =head1 Testing
294
295 XXX Any significant changes to the testing of a freshly built perl should be
296 listed here.  Changes which create B<new> files in F<t/> go here as do any
297 large changes to the testing harness (e.g. when parallel testing was added).
298 Changes to existing files in F<t/> aren't worth summarizing, although the bugs
299 that they represent may be covered elsewhere.
300
301 XXX If there were no significant test changes, say this:
302
303 Tests were added and changed to reflect the other additions and changes
304 in this release.
305
306 XXX If instead there were significant changes, say this:
307
308 Tests were added and changed to reflect the other additions and
309 changes in this release.  Furthermore, these significant changes were
310 made:
311
312 [ List each test improvement as an =item entry ]
313
314 =over 4
315
316 =item *
317
318 XXX
319
320 =back
321
322 =head1 Platform Support
323
324 =head2 New Platforms
325
326 =over 4
327
328 =item 9front
329
330 Allow building Perl on i386 9front systems (fork of plan9).
331
332 =back
333
334 =head2 Updated Platforms
335
336 =over 4
337
338 =item Plan9
339
340 Improve support for Plan9 on i386 platforms.
341
342 =back
343
344 =head2 Discontinued Platforms
345
346 =over 4
347
348 =item Symbian
349
350 Support code relating to Symbian has been removed.  Symbian was an
351 operating system for mobile devices.  The port was last updated in July
352 2009, and the platform itself in October 2012.
353
354 =back
355
356 =head2 Platform-Specific Notes
357
358 XXX List any changes for specific platforms.  This could include configuration
359 and compilation changes or changes in portability/compatibility.  However,
360 changes within modules for platforms should generally be listed in the
361 L</Modules and Pragmata> section.
362
363 =over 4
364
365 =item z/OS
366
367 The locale categories C<LC_SYNTAX> and C<LC_TOD> are now recognized.
368 Perl doesn't do anything with these, except it now allows you to specify
369 them.  They are included in C<LC_ALL>.
370
371 =back
372
373 =head1 Internal Changes
374
375 XXX Changes which affect the interface available to C<XS> code go here.  Other
376 significant internal changes for future core maintainers should be noted as
377 well.
378
379 =over 4
380
381 =item *
382
383 The C<PERL_GLOBAL_STRUCT> compilation option has been removed, and
384 with it the need or the C<dVAR> macro.  C<dVAR> remains defined as a
385 no-op outside C<PERL_CORE> for backwards compatiblity with XS modules.
386
387 =item *
388
389 A new savestack type C<SAVEt_HINTS_HH> has been added, which neatens the
390 previous behaviour of C<SAVEt_HINTS>.  On previous versions the types and
391 values pushed to the save stack would depend on whether the hints included the
392 C<HINT_LOCALIZE_HH> bit, which complicates external code that inspects the
393 save stack. The new version uses a different savestack type to indicate the
394 difference.
395
396 =item *
397
398 A new API function L<perlapi/av_count> has been added which gives a
399 clearly named way to find how many elements are in an array.
400
401 =back
402
403 =head1 Selected Bug Fixes
404
405 XXX Important bug fixes in the core language are summarized here.  Bug fixes in
406 files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>.
407
408 [ List each fix as an =item entry ]
409
410 =over 4
411
412 =item *
413
414 IO::Handle: Fix a spurious error reported for regular file handles.  GH #18019
415
416 =back
417
418 =head1 Known Problems
419
420 XXX Descriptions of platform agnostic bugs we know we can't fix go here.  Any
421 tests that had to be C<TODO>ed for the release would be noted here.  Unfixed
422 platform specific bugs also go here.
423
424 [ List each fix as an =item entry ]
425
426 =over 4
427
428 =item *
429
430 XXX
431
432 =back
433
434 =head1 Errata From Previous Releases
435
436 =over 4
437
438 =item *
439
440 XXX Add anything here that we forgot to add, or were mistaken about, in
441 the perldelta of a previous release.
442
443 =back
444
445 =head1 Obituary
446
447 XXX If any significant core contributor or member of the CPAN community has
448 died, add a short obituary here.
449
450 =head1 Acknowledgements
451
452 XXX Generate this with:
453
454   perl Porting/acknowledgements.pl v5.33.0..HEAD
455
456 =head1 Reporting Bugs
457
458 If you find what you think is a bug, you might check the perl bug database
459 at L<https://github.com/Perl/perl5/issues>.  There may also be information at
460 L<http://www.perl.org/>, the Perl Home Page.
461
462 If you believe you have an unreported bug, please open an issue at
463 L<https://github.com/Perl/perl5/issues>.  Be sure to trim your bug down to a
464 tiny but sufficient test case.
465
466 If the bug you are reporting has security implications which make it
467 inappropriate to send to a public issue tracker, then see
468 L<perlsec/SECURITY VULNERABILITY CONTACT INFORMATION>
469 for details of how to report the issue.
470
471 =head1 Give Thanks
472
473 If you wish to thank the Perl 5 Porters for the work we had done in Perl 5,
474 you can do so by running the C<perlthanks> program:
475
476     perlthanks
477
478 This will send an email to the Perl 5 Porters list with your show of thanks.
479
480 =head1 SEE ALSO
481
482 The F<Changes> file for an explanation of how to view exhaustive details on
483 what changed.
484
485 The F<INSTALL> file for how to build Perl.
486
487 The F<README> file for general stuff.
488
489 The F<Artistic> and F<Copying> files for copyright information.
490
491 =cut