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