Commit | Line | Data |
---|---|---|
e111cbd4 FC |
1 | =encoding utf8 |
2 | ||
3 | =head1 NAME | |
4 | ||
5 | [ this is a template for a new perldelta file. Any text flagged as XXX needs | |
6 | to be processed before release. ] | |
7 | ||
8 | perldelta - what is new for perl v5.20.0 | |
9 | ||
10 | =head1 DESCRIPTION | |
11 | ||
12 | This document describes differences between the 5.18.0 release and the | |
13 | 5.20.0 release. | |
14 | ||
15 | If you are upgrading from an earlier release such as 5.16.0, first read | |
16 | L<perl5180delta>, which describes differences between 5.16.0 and 5.18.0. | |
17 | ||
18 | =head1 Notice | |
19 | ||
20 | XXX Any important notices here | |
21 | ||
22 | =head1 Core Enhancements | |
23 | ||
24 | XXX New core language features go here. Summarize user-visible core language | |
25 | enhancements. Particularly prominent performance optimisations could go | |
26 | here, but most should go in the L</Performance Enhancements> section. | |
27 | ||
28 | [ List each enhancement as a =head2 entry ] | |
29 | ||
30 | =head1 Security | |
31 | ||
32 | XXX Any security-related notices go here. In particular, any security | |
33 | vulnerabilities closed should be noted here rather than in the | |
34 | L</Selected Bug Fixes> section. | |
35 | ||
36 | [ List each security issue as a =head2 entry ] | |
37 | ||
38 | =head1 Incompatible Changes | |
39 | ||
40 | XXX For a release on a stable branch, this section aspires to be: | |
41 | ||
42 | There are no changes intentionally incompatible with 5.XXX.XXX | |
43 | If any exist, they are bugs, and we request that you submit a | |
44 | report. See L</Reporting Bugs> below. | |
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 | ||
52 | =head2 Module removals | |
53 | ||
54 | XXX Remove this section if inapplicable. | |
55 | ||
56 | The following modules will be removed from the core distribution in a | |
57 | future release, and will at that time need to be installed from CPAN. | |
58 | Distributions on CPAN which require these modules will need to list them as | |
59 | prerequisites. | |
60 | ||
61 | The core versions of these modules will now issue C<"deprecated">-category | |
62 | warnings to alert you to this fact. To silence these deprecation warnings, | |
63 | install the modules in question from CPAN. | |
64 | ||
65 | Note that these are (with rare exceptions) fine modules that you are encouraged | |
66 | to continue to use. Their disinclusion from core primarily hinges on their | |
67 | necessity to bootstrapping a fully functional, CPAN-capable Perl installation, | |
68 | not usually on concerns over their design. | |
69 | ||
70 | =over | |
71 | ||
72 | XXX Note that deprecated modules should be listed here even if they are listed | |
73 | as an updated module in the L</Modules and Pragmata> section. | |
74 | ||
75 | =back | |
76 | ||
77 | [ List each other deprecation as a =head2 entry ] | |
78 | ||
79 | =head1 Performance Enhancements | |
80 | ||
81 | XXX Changes which enhance performance without changing behaviour go here. | |
82 | There may well be none in a stable release. | |
83 | ||
84 | [ List each enhancement as a =item entry ] | |
85 | ||
86 | =over 4 | |
87 | ||
88 | =item * | |
89 | ||
90 | XXX | |
91 | ||
92 | =back | |
93 | ||
94 | =head1 Modules and Pragmata | |
95 | ||
96 | XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/> | |
97 | go here. If Module::CoreList is updated, generate an initial draft of the | |
98 | following sections using F<Porting/corelist-perldelta.pl>, which prints stub | |
99 | entries to STDOUT. Results can be pasted in place of the '=head2' entries | |
100 | below. A paragraph summary for important changes should then be added by hand. | |
101 | In an ideal world, dual-life modules would have a F<Changes> file that could be | |
102 | cribbed. | |
103 | ||
104 | [ Within each section, list entries as a =item entry ] | |
105 | ||
106 | =head2 New Modules and Pragmata | |
107 | ||
108 | =over 4 | |
109 | ||
110 | =item * | |
111 | ||
112 | XXX | |
113 | ||
114 | =back | |
115 | ||
116 | =head2 Updated Modules and Pragmata | |
117 | ||
118 | =over 4 | |
119 | ||
120 | =item * | |
121 | ||
122 | L<XXX> has been upgraded from version A.xx to B.yy. | |
123 | ||
124 | =back | |
125 | ||
126 | =head2 Removed Modules and Pragmata | |
127 | ||
128 | =over 4 | |
129 | ||
130 | =item * | |
131 | ||
132 | XXX | |
133 | ||
134 | =back | |
135 | ||
136 | =head1 Documentation | |
137 | ||
138 | XXX Changes to files in F<pod/> go here. Consider grouping entries by | |
139 | file and be sure to link to the appropriate page, e.g. L<perlfunc>. | |
140 | ||
141 | =head2 New Documentation | |
142 | ||
143 | XXX Changes which create B<new> files in F<pod/> go here. | |
144 | ||
145 | =head3 L<XXX> | |
146 | ||
147 | XXX Description of the purpose of the new file here | |
148 | ||
149 | =head2 Changes to Existing Documentation | |
150 | ||
151 | XXX Changes which significantly change existing files in F<pod/> go here. | |
152 | However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics> | |
153 | section. | |
154 | ||
155 | =head3 L<XXX> | |
156 | ||
157 | =over 4 | |
158 | ||
159 | =item * | |
160 | ||
161 | XXX Description of the change here | |
162 | ||
163 | =back | |
164 | ||
165 | =head1 Diagnostics | |
166 | ||
167 | The following additions or changes have been made to diagnostic output, | |
168 | including warnings and fatal error messages. For the complete list of | |
169 | diagnostic messages, see L<perldiag>. | |
170 | ||
171 | XXX New or changed warnings emitted by the core's C<C> code go here. Also | |
172 | include any changes in L<perldiag> that reconcile it to the C<C> code. | |
173 | ||
174 | =head2 New Diagnostics | |
175 | ||
176 | XXX Newly added diagnostic messages go under here, separated into New Errors | |
177 | and New Warnings | |
178 | ||
179 | =head3 New Errors | |
180 | ||
181 | =over 4 | |
182 | ||
183 | =item * | |
184 | ||
185 | XXX L<message|perldiag/"message"> | |
186 | ||
187 | =back | |
188 | ||
189 | =head3 New Warnings | |
190 | ||
191 | =over 4 | |
192 | ||
193 | =item * | |
194 | ||
195 | XXX L<message|perldiag/"message"> | |
196 | ||
197 | =back | |
198 | ||
199 | =head2 Changes to Existing Diagnostics | |
200 | ||
201 | XXX Changes (i.e. rewording) of diagnostic messages go here | |
202 | ||
203 | =over 4 | |
204 | ||
205 | =item * | |
206 | ||
207 | XXX Describe change here | |
208 | ||
209 | =back | |
210 | ||
211 | =head1 Utility Changes | |
212 | ||
213 | XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here. | |
214 | Most of these are built within the directories F<utils> and F<x2p>. | |
215 | ||
216 | [ List utility changes as a =head3 entry for each utility and =item | |
217 | entries for each change | |
218 | Use L<XXX> with program names to get proper documentation linking. ] | |
219 | ||
220 | =head3 L<XXX> | |
221 | ||
222 | =over 4 | |
223 | ||
224 | =item * | |
225 | ||
226 | XXX | |
227 | ||
228 | =back | |
229 | ||
230 | =head1 Configuration and Compilation | |
231 | ||
232 | XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools | |
233 | go here. Any other changes to the Perl build process should be listed here. | |
234 | However, any platform-specific changes should be listed in the | |
235 | L</Platform Support> section, instead. | |
236 | ||
237 | [ List changes as a =item entry ]. | |
238 | ||
239 | =over 4 | |
240 | ||
241 | =item * | |
242 | ||
243 | XXX | |
244 | ||
245 | =back | |
246 | ||
247 | =head1 Testing | |
248 | ||
249 | XXX Any significant changes to the testing of a freshly built perl should be | |
250 | listed here. Changes which create B<new> files in F<t/> go here as do any | |
251 | large changes to the testing harness (e.g. when parallel testing was added). | |
252 | Changes to existing files in F<t/> aren't worth summarizing, although the bugs | |
253 | that they represent may be covered elsewhere. | |
254 | ||
255 | [ List each test improvement as a =item entry ] | |
256 | ||
257 | =over 4 | |
258 | ||
259 | =item * | |
260 | ||
261 | XXX | |
262 | ||
263 | =back | |
264 | ||
265 | =head1 Platform Support | |
266 | ||
267 | XXX Any changes to platform support should be listed in the sections below. | |
268 | ||
269 | [ Within the sections, list each platform as a =item entry with specific | |
270 | changes as paragraphs below it. ] | |
271 | ||
272 | =head2 New Platforms | |
273 | ||
274 | XXX List any platforms that this version of perl compiles on, that previous | |
275 | versions did not. These will either be enabled by new files in the F<hints/> | |
276 | directories, or new subdirectories and F<README> files at the top level of the | |
277 | source tree. | |
278 | ||
279 | =over 4 | |
280 | ||
281 | =item XXX-some-platform | |
282 | ||
283 | XXX | |
284 | ||
285 | =back | |
286 | ||
287 | =head2 Discontinued Platforms | |
288 | ||
289 | XXX List any platforms that this version of perl no longer compiles on. | |
290 | ||
291 | =over 4 | |
292 | ||
293 | =item XXX-some-platform | |
294 | ||
295 | XXX | |
296 | ||
297 | =back | |
298 | ||
299 | =head2 Platform-Specific Notes | |
300 | ||
301 | XXX List any changes for specific platforms. This could include configuration | |
302 | and compilation changes or changes in portability/compatibility. However, | |
303 | changes within modules for platforms should generally be listed in the | |
304 | L</Modules and Pragmata> section. | |
305 | ||
306 | =over 4 | |
307 | ||
308 | =item XXX-some-platform | |
309 | ||
310 | XXX | |
311 | ||
312 | =back | |
313 | ||
314 | =head1 Internal Changes | |
315 | ||
316 | XXX Changes which affect the interface available to C<XS> code go here. Other | |
317 | significant internal changes for future core maintainers should be noted as | |
318 | well. | |
319 | ||
320 | [ List each change as a =item entry ] | |
321 | ||
322 | =over 4 | |
323 | ||
324 | =item * | |
325 | ||
326 | XXX | |
327 | ||
328 | =back | |
329 | ||
330 | =head1 Selected Bug Fixes | |
331 | ||
332 | XXX Important bug fixes in the core language are summarized here. Bug fixes in | |
333 | files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>. | |
334 | ||
335 | [ List each fix as a =item entry ] | |
336 | ||
337 | =over 4 | |
338 | ||
339 | =item * | |
340 | ||
341 | XXX | |
342 | ||
343 | =back | |
344 | ||
345 | =head1 Known Problems | |
346 | ||
347 | XXX Descriptions of platform agnostic bugs we know we can't fix go here. Any | |
348 | tests that had to be C<TODO>ed for the release would be noted here. Unfixed | |
349 | platform specific bugs also go here. | |
350 | ||
351 | [ List each fix as a =item entry ] | |
352 | ||
353 | =over 4 | |
354 | ||
355 | =item * | |
356 | ||
508d2c0a FC |
357 | The following modules are known to have test failures with this version of |
358 | Perl. Patches have been submitted, so there will hopefully be new releases | |
359 | soon: | |
360 | ||
361 | XXX Go through this list just before the release of 5.20 and remove any | |
362 | modules that have been fixed. | |
363 | ||
364 | =over | |
365 | ||
366 | =item * | |
55c1cada | 367 | |
5d92b2b4 FC |
368 | L<Data::Alias> version 1.17 |
369 | ||
370 | =item * | |
371 | ||
372 | L<Data::Structure::Util> version 0.15 | |
373 | ||
374 | =item * | |
375 | ||
376 | L<Data::Util> version 0.62 | |
377 | ||
378 | =item * | |
379 | ||
5d92b2b4 FC |
380 | L<Glib> version 1.301 |
381 | ||
382 | =item * | |
383 | ||
55c1cada | 384 | L<HTML::StripScripts> version 1.05 |
508d2c0a FC |
385 | |
386 | =item * | |
387 | ||
388 | L<LaTeX::Encode> version 0.08 | |
389 | ||
390 | =item | |
391 | ||
a580c898 | 392 | L<Mail::SpamAssassin> version 3.3.2 |
508d2c0a | 393 | |
082ae057 FC |
394 | =item |
395 | ||
5d92b2b4 FC |
396 | L<Mouse> version 1.11 |
397 | ||
398 | =item | |
399 | ||
082ae057 FC |
400 | L<Tk> version 804.031 |
401 | ||
508d2c0a | 402 | =back |
e111cbd4 FC |
403 | |
404 | =back | |
405 | ||
406 | =head1 Obituary | |
407 | ||
408 | XXX If any significant core contributor has died, we've added a short obituary | |
409 | here. | |
410 | ||
411 | =head1 Acknowledgements | |
412 | ||
413 | XXX Generate this with: | |
414 | ||
37a44ba6 | 415 | perl Porting/acknowledgements.pl v5.19.5..HEAD |
e111cbd4 FC |
416 | |
417 | =head1 Reporting Bugs | |
418 | ||
419 | If you find what you think is a bug, you might check the articles recently | |
420 | posted to the comp.lang.perl.misc newsgroup and the perl bug database at | |
421 | http://rt.perl.org/perlbug/ . There may also be information at | |
422 | http://www.perl.org/ , the Perl Home Page. | |
423 | ||
424 | If you believe you have an unreported bug, please run the L<perlbug> program | |
425 | included with your release. Be sure to trim your bug down to a tiny but | |
426 | sufficient test case. Your bug report, along with the output of C<perl -V>, | |
427 | will be sent off to perlbug@perl.org to be analysed by the Perl porting team. | |
428 | ||
429 | If the bug you are reporting has security implications, which make it | |
430 | inappropriate to send to a publicly archived mailing list, then please send it | |
431 | to perl5-security-report@perl.org. This points to a closed subscription | |
432 | unarchived mailing list, which includes all the core committers, who will be | |
433 | able to help assess the impact of issues, figure out a resolution, and help | |
434 | co-ordinate the release of patches to mitigate or fix the problem across all | |
435 | platforms on which Perl is supported. Please only use this address for | |
436 | security issues in the Perl core, not for modules independently distributed on | |
437 | CPAN. | |
438 | ||
439 | =head1 SEE ALSO | |
440 | ||
441 | The F<Changes> file for an explanation of how to view exhaustive details on | |
442 | what changed. | |
443 | ||
444 | The F<INSTALL> file for how to build Perl. | |
445 | ||
446 | The F<README> file for general stuff. | |
447 | ||
448 | The F<Artistic> and F<Copying> files for copyright information. | |
449 | ||
450 | =cut |