This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Eliminate remaining uses of PL_statbuf
[perl5.git] / pod / perldelta.pod
CommitLineData
44691e6f
AB
1=encoding utf8
2
3=head1 NAME
4
b5cbfe35
S
5[ this is a template for a new perldelta file. Any text flagged as XXX needs
6to be processed before release. ]
eabfc7bc 7
1b510166 8perldelta - what is new for perl v5.27.1
89853d76 9
b5cbfe35 10=head1 DESCRIPTION
89853d76 11
1b510166 12This document describes differences between the 5.27.0 release and the 5.27.1
b5cbfe35 13release.
89853d76 14
1b510166
S
15If you are upgrading from an earlier release such as 5.26.0, first read
16L<perl5270delta>, which describes differences between 5.26.0 and 5.27.0.
17
18=head1 Notice
19
20XXX Any important notices here
21
22=head1 Core Enhancements
23
24XXX New core language features go here. Summarize user-visible core language
25enhancements. Particularly prominent performance optimisations could go
26here, but most should go in the L</Performance Enhancements> section.
27
28[ List each enhancement as a =head2 entry ]
29
30=head1 Security
31
32XXX Any security-related notices go here. In particular, any security
33vulnerabilities closed should be noted here rather than in the
34L</Selected Bug Fixes> section.
35
36[ List each security issue as a =head2 entry ]
37
38=head1 Incompatible Changes
39
40XXX 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
c7321345
DIM
48=head2 Comma-less variable lists in formats are no longer allowed
49
50Omitting the commas between variables passed to formats is no longer
51allowed. This has been deprecated since perl 5.000.
52
85cd139f
DIM
53=head2 The C<:locked> and C<:unique> attributes have been removed
54
55These have been no-ops and deprecated since perl 5.12 and 5.10,
56respectively.
57
1b510166
S
58=head1 Deprecations
59
60XXX Any deprecated features, syntax, modules etc. should be listed here.
61
62=head2 Module removals
63
64XXX Remove this section if inapplicable.
65
66The following modules will be removed from the core distribution in a
67future release, and will at that time need to be installed from CPAN.
68Distributions on CPAN which require these modules will need to list them as
69prerequisites.
70
71The core versions of these modules will now issue C<"deprecated">-category
72warnings to alert you to this fact. To silence these deprecation warnings,
73install the modules in question from CPAN.
74
75Note that these are (with rare exceptions) fine modules that you are encouraged
76to continue to use. Their disinclusion from core primarily hinges on their
77necessity to bootstrapping a fully functional, CPAN-capable Perl installation,
78not usually on concerns over their design.
79
80=over
81
82=item XXX
83
84XXX Note that deprecated modules should be listed here even if they are listed
85as 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
93XXX Changes which enhance performance without changing behaviour go here.
94There 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
102XXX
103
104=back
16beba24 105
b5cbfe35 106=head1 Modules and Pragmata
2c8edc25 107
1b510166
S
108XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
109go here. If Module::CoreList is updated, generate an initial draft of the
110following sections using F<Porting/corelist-perldelta.pl>. A paragraph summary
111for important changes should then be added by hand. In an ideal world,
112dual-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
122XXX
123
124=back
125
a049258c
S
126=head2 Updated Modules and Pragmata
127
128=over 4
fbe3f407 129
759020c9 130=item *
7ca0bfc4 131
1b510166
S
132L<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
142XXX
143
144=back
145
146=head1 Documentation
147
148XXX Changes to files in F<pod/> go here. Consider grouping entries by
149file and be sure to link to the appropriate page, e.g. L<perlfunc>.
150
151=head2 New Documentation
152
153XXX Changes which create B<new> files in F<pod/> go here.
154
155=head3 L<XXX>
156
157XXX Description of the purpose of the new file here
158
159=head2 Changes to Existing Documentation
160
161XXX Changes which significantly change existing files in F<pod/> go here.
162However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
163section.
164
165=head3 L<XXX>
166
167=over 4
a049258c 168
2c8edc25 169=item *
d5c7a4fc 170
1b510166 171XXX Description of the change here
a049258c 172
b5cbfe35 173=back
3abe9611 174
1b510166
S
175=head1 Diagnostics
176
177The following additions or changes have been made to diagnostic output,
178including warnings and fatal error messages. For the complete list of
179diagnostic messages, see L<perldiag>.
180
181XXX New or changed warnings emitted by the core's C<C> code go here. Also
182include any changes in L<perldiag> that reconcile it to the C<C> code.
183
184=head2 New Diagnostics
185
186XXX Newly added diagnostic messages go under here, separated into New Errors
187and New Warnings
188
189=head3 New Errors
190
191=over 4
192
193=item *
194
195XXX L<message|perldiag/"message">
196
197=back
198
199=head3 New Warnings
200
201=over 4
202
203=item *
204
205XXX L<message|perldiag/"message">
206
207=back
208
209=head2 Changes to Existing Diagnostics
210
211XXX Changes (i.e. rewording) of diagnostic messages go here
212
213=over 4
214
215=item *
216
217XXX Describe change here
218
219=back
0cc8c746 220
1b510166 221=head1 Utility Changes
0cc8c746 222
1b510166
S
223XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here.
224Most of these are built within the directory F<utils>.
0cc8c746 225
1b510166
S
226[ List utility changes as a =head2 entry for each utility and =item
227entries for each change
228Use L<XXX> with program names to get proper documentation linking. ]
0cc8c746 229
1b510166 230=head2 L<XXX>
0cc8c746 231
1b510166
S
232=over 4
233
234=item *
235
236XXX
237
238=back
239
240=head1 Configuration and Compilation
241
242XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
243go here. Any other changes to the Perl build process should be listed here.
244However, any platform-specific changes should be listed in the
245L</Platform Support> section, instead.
246
247[ List changes as a =item entry ].
248
249=over 4
250
251=item *
252
253XXX
254
255=back
256
257=head1 Testing
258
259XXX Any significant changes to the testing of a freshly built perl should be
260listed here. Changes which create B<new> files in F<t/> go here as do any
261large changes to the testing harness (e.g. when parallel testing was added).
262Changes to existing files in F<t/> aren't worth summarizing, although the bugs
263that they represent may be covered elsewhere.
264
265[ List each test improvement as a =item entry ]
266
267=over 4
268
269=item *
270
271XXX
272
273=back
274
275=head1 Platform Support
276
277XXX Any changes to platform support should be listed in the sections below.
278
279[ Within the sections, list each platform as a =item entry with specific
280changes as paragraphs below it. ]
281
282=head2 New Platforms
283
284XXX List any platforms that this version of perl compiles on, that previous
285versions did not. These will either be enabled by new files in the F<hints/>
286directories, or new subdirectories and F<README> files at the top level of the
287source tree.
288
289=over 4
290
291=item XXX-some-platform
292
293XXX
294
295=back
296
297=head2 Discontinued Platforms
298
299XXX List any platforms that this version of perl no longer compiles on.
300
301=over 4
302
303=item XXX-some-platform
304
305XXX
306
307=back
308
309=head2 Platform-Specific Notes
310
311XXX List any changes for specific platforms. This could include configuration
312and compilation changes or changes in portability/compatibility. However,
313changes within modules for platforms should generally be listed in the
314L</Modules and Pragmata> section.
315
316=over 4
317
318=item XXX-some-platform
319
320XXX
321
322=back
323
324=head1 Internal Changes
325
326XXX Changes which affect the interface available to C<XS> code go here. Other
327significant internal changes for future core maintainers should be noted as
328well.
329
330[ List each change as a =item entry ]
331
332=over 4
333
334=item *
335
7e30e49f 336The C<PL_statbuf> interpreter variable has been removed.
1b510166
S
337
338=back
339
340=head1 Selected Bug Fixes
341
342XXX Important bug fixes in the core language are summarized here. Bug fixes in
343files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>.
344
345[ List each fix as a =item entry ]
346
347=over 4
348
349=item *
350
351XXX
352
353=back
354
355=head1 Known Problems
356
357XXX Descriptions of platform agnostic bugs we know we can't fix go here. Any
358tests that had to be C<TODO>ed for the release would be noted here. Unfixed
359platform specific bugs also go here.
360
361[ List each fix as a =item entry ]
362
363=over 4
364
365=item *
366
367XXX
368
369=back
370
371=head1 Errata From Previous Releases
372
373=over 4
374
375=item *
376
377XXX Add anything here that we forgot to add, or were mistaken about, in
378the perldelta of a previous release.
379
380=back
381
382=head1 Obituary
383
384XXX If any significant core contributor has died, we've added a short obituary
385here.
386
387=head1 Acknowledgements
0cc8c746 388
1b510166 389XXX Generate this with:
2e0dcc12 390
1b510166 391 perl Porting/acknowledgements.pl v5.25.5..HEAD
f5b73711 392
44691e6f
AB
393=head1 Reporting Bugs
394
b5cbfe35
S
395If you find what you think is a bug, you might check the perl bug database
396at L<https://rt.perl.org/> . There may also be information at
397L<http://www.perl.org/> , the Perl Home Page.
44691e6f 398
e08634c5
SH
399If you believe you have an unreported bug, please run the L<perlbug> program
400included with your release. Be sure to trim your bug down to a tiny but
401sufficient test case. Your bug report, along with the output of C<perl -V>,
b5cbfe35 402will be sent off to perlbug@perl.org to be analysed by the Perl porting team.
44691e6f 403
87c118b9
DM
404If the bug you are reporting has security implications which make it
405inappropriate to send to a publicly archived mailing list, then see
c0ea3294
SH
406L<perlsec/SECURITY VULNERABILITY CONTACT INFORMATION>
407for details of how to report the issue.
44691e6f 408
390ae6f9
S
409=head1 Give Thanks
410
411If you wish to thank the Perl 5 Porters for the work we had done in Perl 5,
412you can do so by running the C<perlthanks> program:
413
414 perlthanks
415
416This will send an email to the Perl 5 Porters list with your show of thanks.
417
44691e6f
AB
418=head1 SEE ALSO
419
e08634c5
SH
420The F<Changes> file for an explanation of how to view exhaustive details on
421what changed.
44691e6f
AB
422
423The F<INSTALL> file for how to build Perl.
424
425The F<README> file for general stuff.
426
427The F<Artistic> and F<Copying> files for copyright information.
428
429=cut