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