This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
84bab832423f18988a752e398c437c9b40b9069d
[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.21.9
9
10 =head1 DESCRIPTION
11
12 This document describes differences between the 5.21.8 release and the 5.21.9
13 release.
14
15 If you are upgrading from an earlier release such as 5.21.7, first read
16 L<perl5218delta>, which describes differences between 5.21.7 and 5.21.8.
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 inapplicable.
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 a =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 [ Within each section, list entries as a =item entry ]
105
106 =head2 New Modules and Pragmata
107
108 =over 4
109
110 =item *
111
112 XXX
113
114 =back
115
116 =head2 Updated Modules and Pragmata
117
118 =over 4
119
120 =item *
121
122 L<B> has been upgraded from version 1.55 to 1.56.
123
124 =item *
125
126 L<bigint>, L<bignum>, L<bigrat> have been upgraded to version 0.39.
127
128 Document in CAVEATS that using strings as numbers won't always invoke
129 the big number overloading, and how to invoke it.  [perl #123064]
130
131 =item *
132
133 L<Devel::Peek> has been upgraded from version 1.21 to 1.22.
134
135 =item *
136
137 L<Encode> has been upgraded from version 2.67 to 2.68.
138
139 Building in C++ mode on Windows now works.
140
141 =item *
142
143 L<Opcode> has been upgraded from version 1.31 to 1.32.
144
145 =item *
146
147 L<PerlIO::scalar> has been upgraded from version 0.21 to 0.22.
148
149 Attempting to write at file positions impossible for the platform now
150 fail early rather than wrapping at 4GB.
151
152 =item *
153
154 L<Win32> has been upgraded from version 0.49 to 0.51.
155
156 GetOSName() now supports Windows 8.1, and building in C++ mode now works.
157
158 =item *
159
160 L<Win32API::File> has been upgraded from version 0.1201 to 0.1202
161
162 Building in C++ mode now works.
163
164 =item *
165
166 L<POSIX> has been upgraded from version 1.49 to 1.50.
167
168 =back
169
170 =head2 Removed Modules and Pragmata
171
172 =over 4
173
174 =item *
175
176 XXX
177
178 =back
179
180 =head1 Documentation
181
182 XXX Changes to files in F<pod/> go here.  Consider grouping entries by
183 file and be sure to link to the appropriate page, e.g. L<perlfunc>.
184
185 =head2 New Documentation
186
187 XXX Changes which create B<new> files in F<pod/> go here.
188
189 =head3 L<XXX>
190
191 XXX Description of the purpose of the new file here
192
193 =head2 Changes to Existing Documentation
194
195 XXX Changes which significantly change existing files in F<pod/> go here.
196 However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
197 section.
198
199 =head3 L<XXX>
200
201 =over 4
202
203 =item *
204
205 XXX Description of the change here
206
207 =back
208
209 =head3 L<perlfaq>
210
211 =over 4
212
213 =item *
214
215 L<perlfaq> has been synchronized with version 5.021009 from CPAN.
216
217 =back
218
219 =head1 Diagnostics
220
221 The following additions or changes have been made to diagnostic output,
222 including warnings and fatal error messages.  For the complete list of
223 diagnostic messages, see L<perldiag>.
224
225 XXX New or changed warnings emitted by the core's C<C> code go here.  Also
226 include any changes in L<perldiag> that reconcile it to the C<C> code.
227
228 =head2 New Diagnostics
229
230 XXX Newly added diagnostic messages go under here, separated into New Errors
231 and New Warnings
232
233 =head3 New Errors
234
235 =over 4
236
237 =item *
238
239 XXX L<message|perldiag/"message">
240
241 =back
242
243 =head3 New Warnings
244
245 =over 4
246
247 =item *
248
249 XXX L<message|perldiag/"message">
250
251 =back
252
253 =head2 Changes to Existing Diagnostics
254
255 XXX Changes (i.e. rewording) of diagnostic messages go here
256
257 =over 4
258
259 =item *
260
261 XXX Describe change here
262
263 =back
264
265 =head1 Utility Changes
266
267 XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here.
268 Most of these are built within the directory F<utils>.
269
270 [ List utility changes as a =head2 entry for each utility and =item
271 entries for each change
272 Use L<XXX> with program names to get proper documentation linking. ]
273
274 =head2 L<XXX>
275
276 =over 4
277
278 =item *
279
280 XXX
281
282 =back
283
284 =head1 Configuration and Compilation
285
286 XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
287 go here.  Any other changes to the Perl build process should be listed here.
288 However, any platform-specific changes should be listed in the
289 L</Platform Support> section, instead.
290
291 [ List changes as a =item entry ].
292
293 =over 4
294
295 =item *
296
297 XXX
298
299 =back
300
301 =head1 Testing
302
303 XXX Any significant changes to the testing of a freshly built perl should be
304 listed here.  Changes which create B<new> files in F<t/> go here as do any
305 large changes to the testing harness (e.g. when parallel testing was added).
306 Changes to existing files in F<t/> aren't worth summarizing, although the bugs
307 that they represent may be covered elsewhere.
308
309 [ List each test improvement as a =item entry ]
310
311 =over 4
312
313 =item *
314
315 XXX
316
317 =back
318
319 =head1 Platform Support
320
321 XXX Any changes to platform support should be listed in the sections below.
322
323 [ Within the sections, list each platform as a =item entry with specific
324 changes as paragraphs below it. ]
325
326 =head2 New Platforms
327
328 XXX List any platforms that this version of perl compiles on, that previous
329 versions did not.  These will either be enabled by new files in the F<hints/>
330 directories, or new subdirectories and F<README> files at the top level of the
331 source tree.
332
333 =over 4
334
335 =item XXX-some-platform
336
337 XXX
338
339 =back
340
341 =head2 Discontinued Platforms
342
343 XXX List any platforms that this version of perl no longer compiles on.
344
345 =over 4
346
347 =item XXX-some-platform
348
349 XXX
350
351 =back
352
353 =head2 Platform-Specific Notes
354
355 XXX List any changes for specific platforms.  This could include configuration
356 and compilation changes or changes in portability/compatibility.  However,
357 changes within modules for platforms should generally be listed in the
358 L</Modules and Pragmata> section.
359
360 =over 4
361
362 =item Windows
363
364 Perl can now be built in C++ mode on Windows by setting the makefile macro
365 C<USE_CPLUSPLUS> to the value "define".
366
367 =back
368
369 =head1 Internal Changes
370
371 XXX Changes which affect the interface available to C<XS> code go here.  Other
372 significant internal changes for future core maintainers should be noted as
373 well.
374
375 [ List each change as a =item entry ]
376
377 =over 4
378
379 =item *
380
381 XXX
382
383 =back
384
385 =head1 Selected Bug Fixes
386
387 XXX Important bug fixes in the core language are summarized here.  Bug fixes in
388 files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>.
389
390 [ List each fix as a =item entry ]
391
392 =over 4
393
394 =item *
395
396 XXX
397
398 =back
399
400 =head1 Known Problems
401
402 XXX Descriptions of platform agnostic bugs we know we can't fix go here.  Any
403 tests that had to be C<TODO>ed for the release would be noted here.  Unfixed
404 platform specific bugs also go here.
405
406 [ List each fix as a =item entry ]
407
408 =over 4
409
410 =item *
411
412 XXX
413
414 =back
415
416 =head1 Errata From Previous Releases
417
418 =over 4
419
420 =item *
421
422 XXX Add anything here that we forgot to add, or were mistaken about, in
423 the perldelta of a previous release.
424
425 =back
426
427 =head1 Obituary
428
429 XXX If any significant core contributor has died, we've added a short obituary
430 here.
431
432 =head1 Acknowledgements
433
434 XXX Generate this with:
435
436   perl Porting/acknowledgements.pl v5.21.8..HEAD
437
438 =head1 Reporting Bugs
439
440 If you find what you think is a bug, you might check the articles recently
441 posted to the comp.lang.perl.misc newsgroup and the perl bug database at
442 https://rt.perl.org/ .  There may also be information at
443 http://www.perl.org/ , the Perl Home Page.
444
445 If you believe you have an unreported bug, please run the L<perlbug> program
446 included with your release.  Be sure to trim your bug down to a tiny but
447 sufficient test case.  Your bug report, along with the output of C<perl -V>,
448 will be sent off to perlbug@perl.org to be analysed by the Perl porting team.
449
450 If the bug you are reporting has security implications, which make it
451 inappropriate to send to a publicly archived mailing list, then please send it
452 to perl5-security-report@perl.org.  This points to a closed subscription
453 unarchived mailing list, which includes all the core committers, who will be
454 able to help assess the impact of issues, figure out a resolution, and help
455 co-ordinate the release of patches to mitigate or fix the problem across all
456 platforms on which Perl is supported.  Please only use this address for
457 security issues in the Perl core, not for modules independently distributed on
458 CPAN.
459
460 =head1 SEE ALSO
461
462 The F<Changes> file for an explanation of how to view exhaustive details on
463 what changed.
464
465 The F<INSTALL> file for how to build Perl.
466
467 The F<README> file for general stuff.
468
469 The F<Artistic> and F<Copying> files for copyright information.
470
471 =cut