788cd57fb05e42d7d8ee01c6c2f64b5066fcd716
[perl.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
6 XXX needs to be processed before release. ]
7
8 perldelta - what is new for perl v5.15.6
9
10 =head1 DESCRIPTION
11
12 This document describes differences between the 5.15.5 release and
13 the 5.15.6 release.
14
15 If you are upgrading from an earlier release such as 5.15.4, first read
16 L<perl5155delta>, which describes differences between 5.15.4 and
17 5.15.5.
18
19 =head1 Notice
20
21 XXX Any important notices here
22
23 =head1 Core Enhancements
24
25 XXX New core language features go here. Summarise user-visible core language
26 enhancements. Particularly prominent performance optimisations could go
27 here, but most should go in the L</Performance Enhancements> section.
28
29 [ List each enhancement as a =head2 entry ]
30
31 =head1 Security
32
33 XXX Any security-related notices go here.  In particular, any security
34 vulnerabilities closed should be noted here rather than in the
35 L</Selected Bug Fixes> section.
36
37 [ List each security issue as a =head2 entry ]
38
39 =head1 Incompatible Changes
40
41 XXX For a release on a stable branch, this section aspires to be:
42
43     There are no changes intentionally incompatible with 5.XXX.XXX
44     If any exist, they are bugs and reports are welcome.
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 In particular, deprecated modules should be listed here even if they are
52 listed as an updated module in the L</Modules and Pragmata> section.
53
54 [ List each deprecation as a =head2 entry ]
55
56 =head1 Performance Enhancements
57
58 XXX Changes which enhance performance without changing behaviour go here. There
59 may well be none in a stable release.
60
61 [ List each enhancement as a =item entry ]
62
63 =over 4
64
65 =item *
66
67 XXX
68
69 =back
70
71 =head1 Modules and Pragmata
72
73 XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
74 go here.  If Module::CoreList is updated, generate an initial draft of the
75 following sections using F<Porting/corelist-perldelta.pl>, which prints stub
76 entries to STDOUT.  Results can be pasted in place of the '=head2' entries
77 below.  A paragraph summary for important changes should then be added by hand.
78 In an ideal world, dual-life modules would have a F<Changes> file that could be
79 cribbed.
80
81 [ Within each section, list entries as a =item entry ]
82
83 =head2 New Modules and Pragmata
84
85 =over 4
86
87 =item *
88
89 XXX
90
91 =back
92
93 =head2 Updated Modules and Pragmata
94
95 =over 4
96
97 =item *
98
99 L<Archive::Tar> has been upgraded from version 1.80 to version 1.82.
100
101 Adjustments to handle files >8gb (>0777777777777 octal) and a feature to
102 return the MD5SUM of files in the archive.
103
104 =item *
105
106 L<AutoLoader> has been upgraded from version 5.71 to version 5.72.
107
108 =item *
109
110 L<B::Debug> has been upgraded from version 1.16 to version 1.17.
111
112 =item *
113
114 L<Compress::Raw::Zlib> has been upgraded from version 2.042 to version 2.043.
115
116 =item *
117
118 L<Compress::Raw::Bzip2> has been upgraded from version 2.042 to version 2.043.
119
120 =item *
121
122 L<IO::Compress::Base> has been upgraded from version 2.042 to version 2.043.
123
124 =item *
125
126 L<Pod::LaTeX> has been upgraded from version 0.59 to version 0.60.
127
128 Added another LaTeX escape: --- => -{}-{}-
129
130 Pod::LaTeX doesn't handle -- in PODs specially, passing it directly to
131 LaTeX, which then proceeds to replace it with a single -. This patch
132 replaces ----- with -{}-{}-{}-{}-
133
134 =item *
135
136 L<Unicode::Collate> has been upgraded from version 0.85 to version 0.87.
137
138 Tailored compatibility ideographs as well as unified ideographs for
139 the locales: ja, ko, zh__big5han, zh__gb2312han, zh__pinyin, zh__stroke.
140
141 Now Locale/*.pl files are searched in @INC.
142
143 =back
144
145 =head2 Removed Modules and Pragmata
146
147 =over 4
148
149 =item *
150
151 XXX
152
153 =back
154
155 =head1 Documentation
156
157 XXX Changes to files in F<pod/> go here.  Consider grouping entries by
158 file and be sure to link to the appropriate page, e.g. L<perlfunc>.
159
160 =head2 New Documentation
161
162 XXX Changes which create B<new> files in F<pod/> go here.
163
164 =head3 L<XXX>
165
166 XXX Description of the purpose of the new file here
167
168 =head2 Changes to Existing Documentation
169
170 XXX Changes which significantly change existing files in F<pod/> go here.
171 However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
172 section.
173
174 =head3 L<XXX>
175
176 =over 4
177
178 =item *
179
180 XXX Description of the change here
181
182 =back
183
184 =head1 Diagnostics
185
186 The following additions or changes have been made to diagnostic output,
187 including warnings and fatal error messages.  For the complete list of
188 diagnostic messages, see L<perldiag>.
189
190 XXX New or changed warnings emitted by the core's C<C> code go here. Also
191 include any changes in L<perldiag> that reconcile it to the C<C> code.
192
193 [ Within each section, list entries as a =item entry that links to perldiag,
194   e.g.
195
196   =item *
197
198   L<Invalid version object|perldiag/"Invalid version object">
199 ]
200
201 =head2 New Diagnostics
202
203 XXX Newly added diagnostic messages go here
204
205 =head3 New Errors
206
207 =over 4
208
209 =item *
210
211 XXX L<message|perldiag/"message">
212
213 =back
214
215 =head3 New Warnings
216
217 =over 4
218
219 =item *
220
221 XXX L<message|perldiag/"message">
222
223 =back
224
225 =head2 Changes to Existing Diagnostics
226
227 XXX Changes (i.e. rewording) of diagnostic messages go here
228
229 =over 4
230
231 =item *
232
233 XXX Describe change here
234
235 =back
236
237 =head1 Utility Changes
238
239 XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go
240 here. Most of these are built within the directories F<utils> and F<x2p>.
241
242 [ List utility changes as a =head3 entry for each utility and =item
243 entries for each change
244 Use L<XXX> with program names to get proper documentation linking. ]
245
246 =head3 L<XXX>
247
248 =over 4
249
250 =item *
251
252 XXX
253
254 =back
255
256 =head1 Configuration and Compilation
257
258 XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
259 go here.  Any other changes to the Perl build process should be listed here.
260 However, any platform-specific changes should be listed in the
261 L</Platform Support> section, instead.
262
263 [ List changes as a =item entry ].
264
265 =over 4
266
267 =item *
268
269 XXX
270
271 =back
272
273 =head1 Testing
274
275 XXX Any significant changes to the testing of a freshly built perl should be
276 listed here.  Changes which create B<new> files in F<t/> go here as do any
277 large changes to the testing harness (e.g. when parallel testing was added).
278 Changes to existing files in F<t/> aren't worth summarising, although the bugs
279 that they represent may be covered elsewhere.
280
281 [ List each test improvement as a =item entry ]
282
283 =over 4
284
285 =item *
286
287 XXX
288
289 =back
290
291 =head1 Platform Support
292
293 XXX Any changes to platform support should be listed in the sections below.
294
295 [ Within the sections, list each platform as a =item entry with specific
296 changes as paragraphs below it. ]
297
298 =head2 New Platforms
299
300 XXX List any platforms that this version of perl compiles on, that previous
301 versions did not. These will either be enabled by new files in the F<hints/>
302 directories, or new subdirectories and F<README> files at the top level of the
303 source tree.
304
305 =over 4
306
307 =item XXX-some-platform
308
309 XXX
310
311 =back
312
313 =head2 Discontinued Platforms
314
315 XXX List any platforms that this version of perl no longer compiles on.
316
317 =over 4
318
319 =item XXX-some-platform
320
321 XXX
322
323 =back
324
325 =head2 Platform-Specific Notes
326
327 XXX List any changes for specific platforms. This could include configuration
328 and compilation changes or changes in portability/compatibility.  However,
329 changes within modules for platforms should generally be listed in the
330 L</Modules and Pragmata> section.
331
332 =over 4
333
334 =item XXX-some-platform
335
336 XXX
337
338 =back
339
340 =head1 Internal Changes
341
342 XXX Changes which affect the interface available to C<XS> code go here.
343 Other significant internal changes for future core maintainers should
344 be noted as well.
345
346 [ List each change as a =item entry ]
347
348 =over 4
349
350 =item *
351
352 XXX
353
354 =back
355
356 =head1 Selected Bug Fixes
357
358 XXX Important bug fixes in the core language are summarised here.
359 Bug fixes in files in F<ext/> and F<lib/> are best summarised in
360 L</Modules and Pragmata>.
361
362 [ List each fix as a =item entry ]
363
364 =over 4
365
366 =item *
367
368 XXX
369
370 =back
371
372 =head1 Known Problems
373
374 XXX Descriptions of platform agnostic bugs we know we can't fix go here. Any
375 tests that had to be C<TODO>ed for the release would be noted here, unless
376 they were specific to a particular platform (see below).
377
378 This is a list of some significant unfixed bugs, which are regressions
379 from either 5.XXX.XXX or 5.XXX.XXX.
380
381 [ List each fix as a =item entry ]
382
383 =over 4
384
385 =item *
386
387 XXX
388
389 =back
390
391 =head1 Obituary
392
393 XXX If any significant core contributor has died, we've added a short obituary
394 here.
395
396 =head1 Acknowledgements
397
398 XXX Generate this with:
399
400   perl Porting/acknowledgements.pl v5.15.5..HEAD
401
402 =head1 Reporting Bugs
403
404 If you find what you think is a bug, you might check the articles
405 recently posted to the comp.lang.perl.misc newsgroup and the perl
406 bug database at http://rt.perl.org/perlbug/ .  There may also be
407 information at http://www.perl.org/ , the Perl Home Page.
408
409 If you believe you have an unreported bug, please run the L<perlbug>
410 program included with your release.  Be sure to trim your bug down
411 to a tiny but sufficient test case.  Your bug report, along with the
412 output of C<perl -V>, will be sent off to perlbug@perl.org to be
413 analysed by the Perl porting team.
414
415 If the bug you are reporting has security implications, which make it
416 inappropriate to send to a publicly archived mailing list, then please send
417 it to perl5-security-report@perl.org. This points to a closed subscription
418 unarchived mailing list, which includes
419 all the core committers, who will be able
420 to help assess the impact of issues, figure out a resolution, and help
421 co-ordinate the release of patches to mitigate or fix the problem across all
422 platforms on which Perl is supported. Please only use this address for
423 security issues in the Perl core, not for modules independently
424 distributed on CPAN.
425
426 =head1 SEE ALSO
427
428 The F<Changes> file for an explanation of how to view exhaustive details
429 on what changed.
430
431 The F<INSTALL> file for how to build Perl.
432
433 The F<README> file for general stuff.
434
435 The F<Artistic> and F<Copying> files for copyright information.
436
437 =cut