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