This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
7d253548ebaef7fbdebfb8654fdbb13f74ef65f7
[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.19.4
9
10 =head1 DESCRIPTION
11
12 This document describes differences between the 5.19.3 release and the 5.19.4
13 release.
14
15 If you are upgrading from an earlier release such as 5.19.2, first read
16 L<perl5193delta>, which describes differences between 5.19.2 and 5.19.3.
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 XXX Note that deprecated modules should be listed here even if they are listed
73 as an updated module in the L</Modules and Pragmata> section.
74
75 =back
76
77 [ List each other deprecation as a =head2 entry ]
78
79 =head1 Performance Enhancements
80
81 XXX Changes which enhance performance without changing behaviour go here.
82 There may well be none in a stable release.
83
84 [ List each enhancement as a =item entry ]
85
86 =over 4
87
88 =item *
89
90 XXX
91
92 =back
93
94 =head1 Modules and Pragmata
95
96 XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
97 go here.  If Module::CoreList is updated, generate an initial draft of the
98 following sections using F<Porting/corelist-perldelta.pl>, which prints stub
99 entries to STDOUT.  Results can be pasted in place of the '=head2' entries
100 below.  A paragraph summary for important changes should then be added by hand.
101 In an ideal world, dual-life modules would have a F<Changes> file that could be
102 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<Carp> has been upgraded from version 1.31 to 1.32.
123
124 Carp now avoids some unwanted Unicode warnings on older Perls; doesn't
125 affect behaviour with current Perl.
126
127 =item *
128
129 L<Module::CoreList> has been upgraded from version 2.97 to 2.98.
130
131 The list of Perl versions covered has been updated.
132
133 =back
134
135 =head2 Removed Modules and Pragmata
136
137 =over 4
138
139 =item *
140
141 XXX
142
143 =back
144
145 =head1 Documentation
146
147 XXX Changes to files in F<pod/> go here.  Consider grouping entries by
148 file and be sure to link to the appropriate page, e.g. L<perlfunc>.
149
150 =head2 New Documentation
151
152 XXX Changes which create B<new> files in F<pod/> go here.
153
154 =head3 L<XXX>
155
156 XXX Description of the purpose of the new file here
157
158 =head2 Changes to Existing Documentation
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 =head3 L<XXX>
165
166 =over 4
167
168 =item *
169
170 XXX Description of the change here
171
172 =back
173
174 =head1 Diagnostics
175
176 The following additions or changes have been made to diagnostic output,
177 including warnings and fatal error messages.  For the complete list of
178 diagnostic messages, see L<perldiag>.
179
180 XXX New or changed warnings emitted by the core's C<C> code go here.  Also
181 include any changes in L<perldiag> that reconcile it to the C<C> code.
182
183 =head2 New Diagnostics
184
185 XXX Newly added diagnostic messages go under here, separated into New Errors
186 and New Warnings
187
188 =head3 New Errors
189
190 =over 4
191
192 =item *
193
194 XXX L<message|perldiag/"message">
195
196 =back
197
198 =head3 New Warnings
199
200 =over 4
201
202 =item *
203
204 XXX L<message|perldiag/"message">
205
206 =back
207
208 =head2 Changes to Existing Diagnostics
209
210 XXX Changes (i.e. rewording) of diagnostic messages go here
211
212 =over 4
213
214 =item *
215
216 XXX Describe change here
217
218 =back
219
220 =head1 Utility Changes
221
222 XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here.
223 Most of these are built within the directories F<utils> and F<x2p>.
224
225 [ List utility changes as a =head3 entry for each utility and =item
226 entries for each change
227 Use L<XXX> with program names to get proper documentation linking. ]
228
229 =head3 L<find2perl>
230
231 =over 4
232
233 =item *
234
235 L<find2perl> now handler C<?> wildcards correctly. [perl #113054]
236
237 =back
238
239 =head1 Configuration and Compilation
240
241 XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
242 go here.  Any other changes to the Perl build process should be listed here.
243 However, any platform-specific changes should be listed in the
244 L</Platform Support> section, instead.
245
246 [ List changes as a =item entry ].
247
248 =over 4
249
250 =item *
251
252 XXX
253
254 =back
255
256 =head1 Testing
257
258 XXX Any significant changes to the testing of a freshly built perl should be
259 listed here.  Changes which create B<new> files in F<t/> go here as do any
260 large changes to the testing harness (e.g. when parallel testing was added).
261 Changes to existing files in F<t/> aren't worth summarizing, although the bugs
262 that they represent may be covered elsewhere.
263
264 [ List each test improvement as a =item entry ]
265
266 =over 4
267
268 =item *
269
270 XXX
271
272 =back
273
274 =head1 Platform Support
275
276 XXX Any changes to platform support should be listed in the sections below.
277
278 [ Within the sections, list each platform as a =item entry with specific
279 changes as paragraphs below it. ]
280
281 =head2 New Platforms
282
283 XXX List any platforms that this version of perl compiles on, that previous
284 versions did not.  These will either be enabled by new files in the F<hints/>
285 directories, or new subdirectories and F<README> files at the top level of the
286 source tree.
287
288 =over 4
289
290 =item XXX-some-platform
291
292 XXX
293
294 =back
295
296 =head2 Discontinued Platforms
297
298 XXX List any platforms that this version of perl no longer compiles on.
299
300 =over 4
301
302 =item XXX-some-platform
303
304 XXX
305
306 =back
307
308 =head2 Platform-Specific Notes
309
310 XXX List any changes for specific platforms.  This could include configuration
311 and compilation changes or changes in portability/compatibility.  However,
312 changes within modules for platforms should generally be listed in the
313 L</Modules and Pragmata> section.
314
315 =over 4
316
317 =item XXX-some-platform
318
319 XXX
320
321 =back
322
323 =head1 Internal Changes
324
325 XXX Changes which affect the interface available to C<XS> code go here.  Other
326 significant internal changes for future core maintainers should be noted as
327 well.
328
329 [ List each change as a =item entry ]
330
331 =over 4
332
333 =item *
334
335 XXX
336
337 =back
338
339 =head1 Selected Bug Fixes
340
341 XXX Important bug fixes in the core language are summarized here.  Bug fixes in
342 files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>.
343
344 [ List each fix as a =item entry ]
345
346 =over 4
347
348 =item *
349
350 XXX
351
352 =back
353
354 =head1 Known Problems
355
356 XXX Descriptions of platform agnostic bugs we know we can't fix go here.  Any
357 tests that had to be C<TODO>ed for the release would be noted here.  Unfixed
358 platform specific bugs also go here.
359
360 [ List each fix as a =item entry ]
361
362 =over 4
363
364 =item *
365
366 XXX
367
368 =back
369
370 =head1 Obituary
371
372 XXX If any significant core contributor has died, we've added a short obituary
373 here.
374
375 =head1 Acknowledgements
376
377 XXX Generate this with:
378
379   perl Porting/acknowledgements.pl v5.19.3..HEAD
380
381 =head1 Reporting Bugs
382
383 If you find what you think is a bug, you might check the articles recently
384 posted to the comp.lang.perl.misc newsgroup and the perl bug database at
385 http://rt.perl.org/perlbug/ .  There may also be information at
386 http://www.perl.org/ , the Perl Home Page.
387
388 If you believe you have an unreported bug, please run the L<perlbug> program
389 included with your release.  Be sure to trim your bug down to a tiny but
390 sufficient test case.  Your bug report, along with the output of C<perl -V>,
391 will be sent off to perlbug@perl.org to be analysed by the Perl porting team.
392
393 If the bug you are reporting has security implications, which make it
394 inappropriate to send to a publicly archived mailing list, then please send it
395 to perl5-security-report@perl.org.  This points to a closed subscription
396 unarchived mailing list, which includes all the core committers, who will be
397 able to help assess the impact of issues, figure out a resolution, and help
398 co-ordinate the release of patches to mitigate or fix the problem across all
399 platforms on which Perl is supported.  Please only use this address for
400 security issues in the Perl core, not for modules independently distributed on
401 CPAN.
402
403 =head1 SEE ALSO
404
405 The F<Changes> file for an explanation of how to view exhaustive details on
406 what changed.
407
408 The F<INSTALL> file for how to build Perl.
409
410 The F<README> file for general stuff.
411
412 The F<Artistic> and F<Copying> files for copyright information.
413
414 =cut