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.48
[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.13.9
9
10 =head1 DESCRIPTION
11
12 This document describes differences between the 5.13.8 release and
13 the 5.13.9 release.
14
15 If you are upgrading from an earlier release such as 5.13.7, first read
16 L<perl5138delta>, which describes differences between 5.13.7 and
17 5.13.8.
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. If any
44     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 L<CPAN::Meta::YAML> 0.002 has been added as a dual-life module.  It supports a
90 subset of YAML sufficient for reading and writing META.yml and MYMETA.yml files
91 included with CPAN distributions or generated by the module installation
92 toolchain. It should not be used for any other general YAML parsing or
93 generation task.
94
95 =item *
96
97 L<Module::Metadata> 1.000003 has been added as a dual-life module.  It gathers
98 package and POD information from Perl module files.  It is a standalone module
99 based on Module::Build::ModuleInfo for use by other module installation
100 toolchain components.  Module::Build::ModuleInfo has been deprecated in
101 favor of this module instead.
102
103 =item *
104
105 L<Perl::OSType> 1.002 has been added as a dual-life module.  It maps Perl
106 operating system names (e.g. 'dragonfly' or 'MSWin32') to more generic types
107 with standardized names (e.g.  "Unix" or "Windows").  It has been refactored
108 out of Module::Build and ExtUtils::CBuilder and consolidates such mappings into
109 a single location for easier maintenance.
110
111 =back
112
113 =head2 Updated Modules and Pragmata
114
115 =over 4
116
117 =item *
118
119 C<Archive::Extract> has been upgraded from version 0.46 to 0.48
120
121 =item *
122
123 C<CGI> has been upgraded from version 3.50 to 3.51
124
125 =item *
126
127 C<Encode> has been upgraded from version 2.40 to 2.42
128
129 =item *
130
131 C<threads> has been upgraded from version 1.81_03 to 1.82
132
133 =item *
134
135 C<threads::shared> has been upgraded from version 1.35 to 1.36
136
137 =item *
138
139 C<Time::Local> has been upgraded from version 1.1901_01 to 1.2000.
140
141 =back
142
143 =head2 Removed Modules and Pragmata
144
145 =over 4
146
147 =item *
148
149 XXX
150
151 =back
152
153 =head1 Documentation
154
155 XXX Changes to files in F<pod/> go here.  Consider grouping entries by
156 file and be sure to link to the appropriate page, e.g. L<perlfunc>.
157
158 =head2 New Documentation
159
160 XXX Changes which create B<new> files in F<pod/> go here.
161
162 =head3 L<XXX>
163
164 XXX Description of the purpose of the new file here
165
166 =head2 Changes to Existing Documentation
167
168 XXX Changes which significantly change existing files in F<pod/> go here.
169 However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
170 section.
171
172 =head3 L<XXX>
173
174 =over 4
175
176 =item *
177
178 XXX Description of the change here
179
180 =back
181
182 =head1 Diagnostics
183
184 The following additions or changes have been made to diagnostic output,
185 including warnings and fatal error messages.  For the complete list of
186 diagnostic messages, see L<perldiag>.
187
188 XXX New or changed warnings emitted by the core's C<C> code go here. Also
189 include any changes in L<perldiag> that reconcile it to the C<C> code.
190
191 [ Within each section, list entries as a =item entry ]
192
193 =head2 New Diagnostics
194
195 XXX Newly added diagnostic messages go here
196
197 =over 4
198
199 =item *
200
201 XXX
202
203 =back
204
205 =head2 Changes to Existing Diagnostics
206
207 XXX Changes (i.e. rewording) of diagnostic messages go here
208
209 =over 4
210
211 =item *
212
213 XXX
214
215 =back
216
217 =head1 Utility Changes
218
219 XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go
220 here. Most of these are built within the directories F<utils> and F<x2p>.
221
222 [ List utility changes as a =head3 entry for each utility and =item
223 entries for each change
224 Use L<XXX> with program names to get proper documentation linking. ]
225
226 =head3 L<XXX>
227
228 =over 4
229
230 =item *
231
232 XXX
233
234 =back
235
236 =head1 Configuration and Compilation
237
238 XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
239 go here.  Any other changes to the Perl build process should be listed here.
240 However, any platform-specific changes should be listed in the
241 L</Platform Support> section, instead.
242
243 [ List changes as a =item entry ].
244
245 =over 4
246
247 =item *
248
249 XXX
250
251 =back
252
253 =head1 Testing
254
255 XXX Any significant changes to the testing of a freshly built perl should be
256 listed here.  Changes which create B<new> files in F<t/> go here as do any
257 large changes to the testing harness (e.g. when parallel testing was added).
258 Changes to existing files in F<t/> aren't worth summarising, although the bugs
259 that they represent may be covered elsewhere.
260
261 [ List each test improvement as a =item entry ]
262
263 =over 4
264
265 =item *
266
267 XXX
268
269 =back
270
271 =head1 Platform Support
272
273 XXX Any changes to platform support should be listed in the sections below.
274
275 [ Within the sections, list each platform as a =item entry with specific
276 changes as paragraphs below it. ]
277
278 =head2 New Platforms
279
280 XXX List any platforms that this version of perl compiles on, that previous
281 versions did not. These will either be enabled by new files in the F<hints/>
282 directories, or new subdirectories and F<README> files at the top level of the
283 source tree.
284
285 =over 4
286
287 =item XXX-some-platform
288
289 XXX
290
291 =back
292
293 =head2 Discontinued Platforms
294
295 XXX List any platforms that this version of perl no longer compiles on.
296
297 =over 4
298
299 =item XXX-some-platform
300
301 XXX
302
303 =back
304
305 =head2 Platform-Specific Notes
306
307 XXX List any changes for specific platforms. This could include configuration
308 and compilation changes or changes in portability/compatibility.  However,
309 changes within modules for platforms should generally be listed in the
310 L</Modules and Pragmata> section.
311
312 =over 4
313
314 =item XXX-some-platform
315
316 XXX
317
318 =back
319
320 =head1 Internal Changes
321
322 XXX Changes which affect the interface available to C<XS> code go here.
323 Other significant internal changes for future core maintainers should
324 be noted as well.
325
326 [ List each test improvement as a =item entry ]
327
328 =over 4
329
330 =item *
331
332 The opcode bodies for C<chop> and C<chomp> and for C<schop> and C<schomp> have
333 been merged. The implementation functions C<Perl_do_chop()> and
334 C<Perl_do_chomp()>, never part of the public API, have been merged and moved to
335 a static function in F<pp.c>. This shrinks the perl binary slightly, and should
336 not affect any code outside the core (unless it is relying on the order of side
337 effects when C<chomp> is passed a I<list> of values).
338
339 =back
340
341 =head1 Selected Bug Fixes
342
343 XXX Important bug fixes in the core language are summarised here.
344 Bug fixes in files in F<ext/> and F<lib/> are best summarised in
345 L</Modules and Pragmata>.
346
347 [ List each fix as a =item entry ]
348
349 =over 4
350
351 =item *
352
353 XXX
354
355 =back
356
357 =head1 Known Problems
358
359 XXX Descriptions of platform agnostic bugs we know we can't fix go here. Any
360 tests that had to be C<TODO>ed for the release would be noted here, unless
361 they were specific to a particular platform (see below).
362
363 This is a list of some significant unfixed bugs, which are regressions
364 from either 5.XXX.XXX or 5.XXX.XXX.
365
366 [ List each fix as a =item entry ]
367
368 =over 4
369
370 =item *
371
372 XXX
373
374 =back
375
376 =head1 Obituary
377
378 XXX If any significant core contributor has died, we've added a short obituary
379 here.
380
381 =head1 Acknowledgements
382
383 XXX The list of people to thank goes here.
384
385 =head1 Reporting Bugs
386
387 If you find what you think is a bug, you might check the articles
388 recently posted to the comp.lang.perl.misc newsgroup and the perl
389 bug database at http://rt.perl.org/perlbug/ .  There may also be
390 information at http://www.perl.org/ , the Perl Home Page.
391
392 If you believe you have an unreported bug, please run the L<perlbug>
393 program included with your release.  Be sure to trim your bug down
394 to a tiny but sufficient test case.  Your bug report, along with the
395 output of C<perl -V>, will be sent off to perlbug@perl.org to be
396 analysed by the Perl porting team.
397
398 If the bug you are reporting has security implications, which make it
399 inappropriate to send to a publicly archived mailing list, then please send
400 it to perl5-security-report@perl.org. This points to a closed subscription
401 unarchived mailing list, which includes all the core committers, who be able
402 to help assess the impact of issues, figure out a resolution, and help
403 co-ordinate the release of patches to mitigate or fix the problem across all
404 platforms on which Perl is supported. Please only use this address for
405 security issues in the Perl core, not for modules independently
406 distributed on CPAN.
407
408 =head1 SEE ALSO
409
410 The F<Changes> file for an explanation of how to view exhaustive details
411 on what changed.
412
413 The F<INSTALL> file for how to build Perl.
414
415 The F<README> file for general stuff.
416
417 The F<Artistic> and F<Copying> files for copyright information.
418
419 =cut