This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
02bc20ba7ab425f74d25fe0ee087e69c45195315
[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<XXX>
174
175 =over 4
176
177 =item *
178
179 XXX Description of the change here
180
181 =back
182
183 =head1 Diagnostics
184
185 The following additions or changes have been made to diagnostic output,
186 including warnings and fatal error messages.  For the complete list of
187 diagnostic messages, see L<perldiag>.
188
189 XXX New or changed warnings emitted by the core's C<C> code go here.  Also
190 include any changes in L<perldiag> that reconcile it to the C<C> code.
191
192 =head2 New Diagnostics
193
194 XXX Newly added diagnostic messages go under here, separated into New Errors
195 and New Warnings
196
197 =head3 New Errors
198
199 =over 4
200
201 =item *
202
203 XXX L<message|perldiag/"message">
204
205 =back
206
207 =head3 New Warnings
208
209 =over 4
210
211 =item *
212
213 XXX L<message|perldiag/"message">
214
215 =back
216
217 =head2 Changes to Existing Diagnostics
218
219 XXX Changes (i.e. rewording) of diagnostic messages go here
220
221 =over 4
222
223 =item *
224
225 XXX Describe change here
226
227 =back
228
229 =head1 Utility Changes
230
231 XXX Changes to installed programs such as F<perldoc> and F<xsubpp> go here.
232 Most of these are built within the directory F<utils>.
233
234 [ List utility changes as a =head2 entry for each utility and =item
235 entries for each change
236 Use L<XXX> with program names to get proper documentation linking. ]
237
238 =head2 L<perl5db.pl> (the debugger)
239
240 =over 4
241
242 =item * New option: C<HistItemMinLength>
243
244 This option controls the minimum length a command must be to get stored in
245 history.  Traditionally, this has been fixed at 2.  Changes to the debugger
246 are often perilous, and new bugs should be reported so the debugger can be
247 debugged.
248
249 =item * Fix to C<i> and C<l> commands
250
251 The C<i $var> and C<l $var> commands work again with lexical variables.
252
253 =back
254
255 =head1 Configuration and Compilation
256
257 XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
258 go here.  Any other changes to the Perl build process should be listed here.
259 However, any platform-specific changes should be listed in the
260 L</Platform Support> section, instead.
261
262 [ List changes as an =item entry ].
263
264 =over 4
265
266 =item *
267
268 The minimum supported Bison version is now 2.4, and the maxiumm is 3.7.
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 XXX If there were no significant test changes, say this:
281
282 Tests were added and changed to reflect the other additions and changes
283 in this release.
284
285 XXX If instead there were significant changes, say this:
286
287 Tests were added and changed to reflect the other additions and
288 changes in this release.  Furthermore, these significant changes were
289 made:
290
291 [ List each test improvement as an =item entry ]
292
293 =over 4
294
295 =item *
296
297 XXX
298
299 =back
300
301 =head1 Platform Support
302
303 =head2 New Platforms
304
305 =over 4
306
307 =item 9front
308
309 Allow building Perl on i386 9front systems (fork of plan9).
310
311 =back
312
313 =head2 Updated Platforms
314
315 =over 4
316
317 =item Plan9
318
319 Improve support for Plan9 on i386 platforms.
320
321 =back
322
323 =head2 Discontinued Platforms
324
325 =over 4
326
327 =item Symbian
328
329 Support code relating to Symbian has been removed.  Symbian was an
330 operating system for mobile devices.  The port was last updated in July
331 2009, and the platform itself in October 2012.
332
333 =back
334
335 =head2 Platform-Specific Notes
336
337 XXX List any changes for specific platforms.  This could include configuration
338 and compilation changes or changes in portability/compatibility.  However,
339 changes within modules for platforms should generally be listed in the
340 L</Modules and Pragmata> section.
341
342 =over 4
343
344 =item z/OS
345
346 The locale categories C<LC_SYNTAX> and C<LC_TOD> are now recognized.
347 Perl doesn't do anything with these, except it now allows you to specify
348 them.  They are included in C<LC_ALL>.
349
350 =back
351
352 =head1 Internal Changes
353
354 XXX Changes which affect the interface available to C<XS> code go here.  Other
355 significant internal changes for future core maintainers should be noted as
356 well.
357
358 =over 4
359
360 =item *
361
362 The C<PERL_GLOBAL_STRUCT> compilation option has been removed, and
363 with it the need or the C<dVAR> macro.  C<dVAR> remains defined as a
364 no-op outside C<PERL_CORE> for backwards compatiblity with XS modules.
365
366 =item *
367
368 A new savestack type C<SAVEt_HINTS_HH> has been added, which neatens the
369 previous behaviour of C<SAVEt_HINTS>.  On previous versions the types and
370 values pushed to the save stack would depend on whether the hints included the
371 C<HINT_LOCALIZE_HH> bit, which complicates external code that inspects the
372 save stack. The new version uses a different savestack type to indicate the
373 difference.
374
375 =back
376
377 =head1 Selected Bug Fixes
378
379 XXX Important bug fixes in the core language are summarized here.  Bug fixes in
380 files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>.
381
382 [ List each fix as an =item entry ]
383
384 =over 4
385
386 =item *
387
388 XXX
389
390 =back
391
392 =head1 Known Problems
393
394 XXX Descriptions of platform agnostic bugs we know we can't fix go here.  Any
395 tests that had to be C<TODO>ed for the release would be noted here.  Unfixed
396 platform specific bugs also go here.
397
398 [ List each fix as an =item entry ]
399
400 =over 4
401
402 =item *
403
404 XXX
405
406 =back
407
408 =head1 Errata From Previous Releases
409
410 =over 4
411
412 =item *
413
414 XXX Add anything here that we forgot to add, or were mistaken about, in
415 the perldelta of a previous release.
416
417 =back
418
419 =head1 Obituary
420
421 XXX If any significant core contributor or member of the CPAN community has
422 died, add a short obituary here.
423
424 =head1 Acknowledgements
425
426 XXX Generate this with:
427
428   perl Porting/acknowledgements.pl v5.33.0..HEAD
429
430 =head1 Reporting Bugs
431
432 If you find what you think is a bug, you might check the perl bug database
433 at L<https://github.com/Perl/perl5/issues>.  There may also be information at
434 L<http://www.perl.org/>, the Perl Home Page.
435
436 If you believe you have an unreported bug, please open an issue at
437 L<https://github.com/Perl/perl5/issues>.  Be sure to trim your bug down to a
438 tiny but sufficient test case.
439
440 If the bug you are reporting has security implications which make it
441 inappropriate to send to a public issue tracker, then see
442 L<perlsec/SECURITY VULNERABILITY CONTACT INFORMATION>
443 for details of how to report the issue.
444
445 =head1 Give Thanks
446
447 If you wish to thank the Perl 5 Porters for the work we had done in Perl 5,
448 you can do so by running the C<perlthanks> program:
449
450     perlthanks
451
452 This will send an email to the Perl 5 Porters list with your show of thanks.
453
454 =head1 SEE ALSO
455
456 The F<Changes> file for an explanation of how to view exhaustive details on
457 what changed.
458
459 The F<INSTALL> file for how to build Perl.
460
461 The F<README> file for general stuff.
462
463 The F<Artistic> and F<Copying> files for copyright information.
464
465 =cut