This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
5af78af1f4744085a5d52cd98f62a51000cc44ec
[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.25.8
9
10 =head1 DESCRIPTION
11
12 This document describes differences between the 5.25.7 release and the 5.25.8
13 release.
14
15 If you are upgrading from an earlier release such as 5.25.6, first read
16 L<perl5257delta>, which describes differences between 5.25.6 and 5.25.7.
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 New Hash Function For 64-bit Builds
31
32 We have switched to a hybrid hash function to better balance
33 performance for short and long keys.
34
35 For short keys, 16 bytes and under, we use an optimised variant of
36 One At A Time Hard, and for longer keys we use Siphash 1-3. For very
37 long keys this is a big improvement in performance. For shorter keys
38 there is a modest improvement.
39
40 =head1 Security
41
42 XXX Any security-related notices go here.  In particular, any security
43 vulnerabilities closed should be noted here rather than in the
44 L</Selected Bug Fixes> section.
45
46 [ List each security issue as a =head2 entry ]
47
48 =head1 Incompatible Changes
49
50 XXX For a release on a stable branch, this section aspires to be:
51
52     There are no changes intentionally incompatible with 5.XXX.XXX
53     If any exist, they are bugs, and we request that you submit a
54     report.  See L</Reporting Bugs> below.
55
56 [ List each incompatible change as a =head2 entry ]
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 * New Faster Hash Function on 64 bit builds
101
102 We use a different hash function for short and long keys. This should
103 improve performance and security, especially for long keys.
104
105 =item * readline is faster
106
107 Reading from a file line-by-line with c<readline()> or C<< <> >> should
108 now typically be faster due to a better implementation of the code that
109 searches for the next newline character.
110
111 =back
112
113 =head1 Modules and Pragmata
114
115 XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
116 go here.  If Module::CoreList is updated, generate an initial draft of the
117 following sections using F<Porting/corelist-perldelta.pl>.  A paragraph summary
118 for important changes should then be added by hand.  In an ideal world,
119 dual-life modules would have a F<Changes> file that could be cribbed.
120
121 [ Within each section, list entries as a =item entry ]
122
123 =head2 New Modules and Pragmata
124
125 =over 4
126
127 =item *
128
129 XXX
130
131 =back
132
133 =head2 Updated Modules and Pragmata
134
135 =over 4
136
137 =item *
138
139 L<XXX> has been upgraded from version A.xx to B.yy.
140
141 =item *
142
143 L<Pod::Simple> has been upgraded from version 3.32 to 3.35.
144
145 =back
146
147 =head2 Removed Modules and Pragmata
148
149 =over 4
150
151 =item *
152
153 XXX
154
155 =back
156
157 =head1 Documentation
158
159 XXX Changes to files in F<pod/> go here.  Consider grouping entries by
160 file and be sure to link to the appropriate page, e.g. L<perlfunc>.
161
162 =head2 New Documentation
163
164 XXX Changes which create B<new> files in F<pod/> go here.
165
166 =head3 L<XXX>
167
168 XXX Description of the purpose of the new file here
169
170 =head2 Changes to Existing Documentation
171
172 XXX Changes which significantly change existing files in F<pod/> go here.
173 However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
174 section.
175
176 =head3 L<XXX>
177
178 =over 4
179
180 =item *
181
182 XXX Description of the change here
183
184 =back
185
186 =head1 Diagnostics
187
188 The following additions or changes have been made to diagnostic output,
189 including warnings and fatal error messages.  For the complete list of
190 diagnostic messages, see L<perldiag>.
191
192 XXX New or changed warnings emitted by the core's C<C> code go here.  Also
193 include any changes in L<perldiag> that reconcile it to the C<C> code.
194
195 =head2 New Diagnostics
196
197 XXX Newly added diagnostic messages go under here, separated into New Errors
198 and New Warnings
199
200 =head3 New Errors
201
202 =over 4
203
204 =item *
205
206 XXX L<message|perldiag/"message">
207
208 =back
209
210 =head3 New Warnings
211
212 =over 4
213
214 =item *
215
216 XXX L<message|perldiag/"message">
217
218 =back
219
220 =head2 Changes to Existing Diagnostics
221
222 XXX Changes (i.e. rewording) of diagnostic messages go here
223
224 =over 4
225
226 =item *
227
228 XXX Describe change here
229
230 =back
231
232 =head1 Utility Changes
233
234 XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here.
235 Most of these are built within the directory F<utils>.
236
237 [ List utility changes as a =head2 entry for each utility and =item
238 entries for each change
239 Use L<XXX> with program names to get proper documentation linking. ]
240
241 =head2 L<XXX>
242
243 =over 4
244
245 =item *
246
247 XXX
248
249 =back
250
251 =head1 Configuration and Compilation
252
253 XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
254 go here.  Any other changes to the Perl build process should be listed here.
255 However, any platform-specific changes should be listed in the
256 L</Platform Support> section, instead.
257
258 [ List changes as a =item entry ].
259
260 =over 4
261
262 =item *
263
264 XXX
265
266 =back
267
268 =head1 Testing
269
270 XXX Any significant changes to the testing of a freshly built perl should be
271 listed here.  Changes which create B<new> files in F<t/> go here as do any
272 large changes to the testing harness (e.g. when parallel testing was added).
273 Changes to existing files in F<t/> aren't worth summarizing, although the bugs
274 that they represent may be covered elsewhere.
275
276 [ List each test improvement as a =item entry ]
277
278 =over 4
279
280 =item *
281
282 XXX
283
284 =back
285
286 =head1 Platform Support
287
288 XXX Any changes to platform support should be listed in the sections below.
289
290 [ Within the sections, list each platform as a =item entry with specific
291 changes as paragraphs below it. ]
292
293 =head2 New Platforms
294
295 XXX List any platforms that this version of perl compiles on, that previous
296 versions did not.  These will either be enabled by new files in the F<hints/>
297 directories, or new subdirectories and F<README> files at the top level of the
298 source tree.
299
300 =over 4
301
302 =item XXX-some-platform
303
304 XXX
305
306 =back
307
308 =head2 Discontinued Platforms
309
310 XXX List any platforms that this version of perl no longer compiles on.
311
312 =over 4
313
314 =item XXX-some-platform
315
316 XXX
317
318 =back
319
320 =head2 Platform-Specific Notes
321
322 XXX List any changes for specific platforms.  This could include configuration
323 and compilation changes or changes in portability/compatibility.  However,
324 changes within modules for platforms should generally be listed in the
325 L</Modules and Pragmata> section.
326
327 =over 4
328
329 =item XXX-some-platform
330
331 XXX
332
333 =back
334
335 =head1 Internal Changes
336
337 XXX Changes which affect the interface available to C<XS> code go here.  Other
338 significant internal changes for future core maintainers should be noted as
339 well.
340
341 [ List each change as a =item entry ]
342
343 =over 4
344
345 =item *
346
347 A new API function, C<sv_set_undef(sv)>, has been added. This is
348 equivalent to C<sv_setsv(sv, &PL_sv_undef)>, but is more efficient.
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 SEE ALSO
422
423 The F<Changes> file for an explanation of how to view exhaustive details on
424 what changed.
425
426 The F<INSTALL> file for how to build Perl.
427
428 The F<README> file for general stuff.
429
430 The F<Artistic> and F<Copying> files for copyright information.
431
432 =cut