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