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