Eliminate remaining uses of PL_statbuf
[perl.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.27.1
9
10 =head1 DESCRIPTION
11
12 This document describes differences between the 5.27.0 release and the 5.27.1
13 release.
14
15 If you are upgrading from an earlier release such as 5.26.0, first read
16 L<perl5270delta>, which describes differences between 5.26.0 and 5.27.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 =head2 Comma-less variable lists in formats are no longer allowed
49
50 Omitting the commas between variables passed to formats is no longer
51 allowed.  This has been deprecated since perl 5.000.
52
53 =head2 The C<:locked> and C<:unique> attributes have been removed
54
55 These have been no-ops and deprecated since perl 5.12 and 5.10,
56 respectively.
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 XXX L<message|perldiag/"message">
196
197 =back
198
199 =head3 New Warnings
200
201 =over 4
202
203 =item *
204
205 XXX L<message|perldiag/"message">
206
207 =back
208
209 =head2 Changes to Existing Diagnostics
210
211 XXX Changes (i.e. rewording) of diagnostic messages go here
212
213 =over 4
214
215 =item *
216
217 XXX Describe change here
218
219 =back
220
221 =head1 Utility Changes
222
223 XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here.
224 Most of these are built within the directory F<utils>.
225
226 [ List utility changes as a =head2 entry for each utility and =item
227 entries for each change
228 Use L<XXX> with program names to get proper documentation linking. ]
229
230 =head2 L<XXX>
231
232 =over 4
233
234 =item *
235
236 XXX
237
238 =back
239
240 =head1 Configuration and Compilation
241
242 XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
243 go here.  Any other changes to the Perl build process should be listed here.
244 However, any platform-specific changes should be listed in the
245 L</Platform Support> section, instead.
246
247 [ List changes as a =item entry ].
248
249 =over 4
250
251 =item *
252
253 XXX
254
255 =back
256
257 =head1 Testing
258
259 XXX Any significant changes to the testing of a freshly built perl should be
260 listed here.  Changes which create B<new> files in F<t/> go here as do any
261 large changes to the testing harness (e.g. when parallel testing was added).
262 Changes to existing files in F<t/> aren't worth summarizing, although the bugs
263 that they represent may be covered elsewhere.
264
265 [ List each test improvement as a =item entry ]
266
267 =over 4
268
269 =item *
270
271 XXX
272
273 =back
274
275 =head1 Platform Support
276
277 XXX 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
280 changes as paragraphs below it. ]
281
282 =head2 New Platforms
283
284 XXX List any platforms that this version of perl compiles on, that previous
285 versions did not.  These will either be enabled by new files in the F<hints/>
286 directories, or new subdirectories and F<README> files at the top level of the
287 source tree.
288
289 =over 4
290
291 =item XXX-some-platform
292
293 XXX
294
295 =back
296
297 =head2 Discontinued Platforms
298
299 XXX List any platforms that this version of perl no longer compiles on.
300
301 =over 4
302
303 =item XXX-some-platform
304
305 XXX
306
307 =back
308
309 =head2 Platform-Specific Notes
310
311 XXX List any changes for specific platforms.  This could include configuration
312 and compilation changes or changes in portability/compatibility.  However,
313 changes within modules for platforms should generally be listed in the
314 L</Modules and Pragmata> section.
315
316 =over 4
317
318 =item XXX-some-platform
319
320 XXX
321
322 =back
323
324 =head1 Internal Changes
325
326 XXX Changes which affect the interface available to C<XS> code go here.  Other
327 significant internal changes for future core maintainers should be noted as
328 well.
329
330 [ List each change as a =item entry ]
331
332 =over 4
333
334 =item *
335
336 The C<PL_statbuf> interpreter variable has been removed.
337
338 =back
339
340 =head1 Selected Bug Fixes
341
342 XXX Important bug fixes in the core language are summarized here.  Bug fixes in
343 files 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
351 XXX
352
353 =back
354
355 =head1 Known Problems
356
357 XXX Descriptions of platform agnostic bugs we know we can't fix go here.  Any
358 tests that had to be C<TODO>ed for the release would be noted here.  Unfixed
359 platform specific bugs also go here.
360
361 [ List each fix as a =item entry ]
362
363 =over 4
364
365 =item *
366
367 XXX
368
369 =back
370
371 =head1 Errata From Previous Releases
372
373 =over 4
374
375 =item *
376
377 XXX Add anything here that we forgot to add, or were mistaken about, in
378 the perldelta of a previous release.
379
380 =back
381
382 =head1 Obituary
383
384 XXX If any significant core contributor has died, we've added a short obituary
385 here.
386
387 =head1 Acknowledgements
388
389 XXX Generate this with:
390
391   perl Porting/acknowledgements.pl v5.25.5..HEAD
392
393 =head1 Reporting Bugs
394
395 If you find what you think is a bug, you might check the perl bug database
396 at L<https://rt.perl.org/> .  There may also be information at
397 L<http://www.perl.org/> , the Perl Home Page.
398
399 If you believe you have an unreported bug, please run the L<perlbug> program
400 included with your release.  Be sure to trim your bug down to a tiny but
401 sufficient test case.  Your bug report, along with the output of C<perl -V>,
402 will be sent off to perlbug@perl.org to be analysed by the Perl porting team.
403
404 If the bug you are reporting has security implications which make it
405 inappropriate to send to a publicly archived mailing list, then see
406 L<perlsec/SECURITY VULNERABILITY CONTACT INFORMATION>
407 for details of how to report the issue.
408
409 =head1 Give Thanks
410
411 If you wish to thank the Perl 5 Porters for the work we had done in Perl 5,
412 you can do so by running the C<perlthanks> program:
413
414     perlthanks
415
416 This will send an email to the Perl 5 Porters list with your show of thanks.
417
418 =head1 SEE ALSO
419
420 The F<Changes> file for an explanation of how to view exhaustive details on
421 what changed.
422
423 The F<INSTALL> file for how to build Perl.
424
425 The F<README> file for general stuff.
426
427 The F<Artistic> and F<Copying> files for copyright information.
428
429 =cut