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