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