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