Commit | Line | Data |
---|---|---|
3a5c9134 CBW |
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.8 | |
9 | ||
10 | =head1 DESCRIPTION | |
11 | ||
12 | This document describes differences between the 5.13.8 release and | |
13 | the 5.13.7 release. | |
14 | ||
dbbe2d83 | 15 | If you are upgrading from an earlier release such as 5.13.6, first read |
3a5c9134 CBW |
16 | L<perl5137delta>, which describes differences between 5.13.6 and |
17 | 5.13.7. | |
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 | ||
d59a8b3e NC |
56 | =head2 C<sv_compile_2op> is now deprecated |
57 | ||
58 | The C<sv_compile_2op> is now deprecated, and will be removed. Searches suggest | |
59 | that nothing on CPAN is using it, so this should have zero impact. | |
60 | ||
61 | It attempted to provide an API to compile code down to an optree, but failed | |
62 | to bind correctly to lexicals in the enclosing scope. It's not possible to | |
63 | fix this problem within the constraints of its parameters and return value. | |
64 | ||
3a5c9134 CBW |
65 | =head1 Performance Enhancements |
66 | ||
67 | XXX Changes which enhance performance without changing behaviour go here. There | |
68 | may well be none in a stable release. | |
69 | ||
70 | [ List each enhancement as a =item entry ] | |
71 | ||
72 | =over 4 | |
73 | ||
74 | =item * | |
75 | ||
76 | XXX | |
77 | ||
78 | =back | |
79 | ||
80 | =head1 Modules and Pragmata | |
81 | ||
82 | XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/> | |
83 | go here. If Module::CoreList is updated, generate an initial draft of the | |
84 | following sections using F<Porting/corelist-perldelta.pl>, which prints stub | |
85 | entries to STDOUT. Results can be pasted in place of the '=head2' entries | |
86 | below. A paragraph summary for important changes should then be added by hand. | |
87 | In an ideal world, dual-life modules would have a F<Changes> file that could be | |
88 | cribbed. | |
89 | ||
90 | [ Within each section, list entries as a =item entry ] | |
91 | ||
92 | =head2 New Modules and Pragmata | |
93 | ||
94 | =over 4 | |
95 | ||
96 | =item * | |
97 | ||
98 | XXX | |
99 | ||
100 | =back | |
101 | ||
102 | =head2 Updated Modules and Pragmata | |
103 | ||
104 | =over 4 | |
105 | ||
106 | =item * | |
107 | ||
39b09a1b CBW |
108 | C<IPC::Cmd> has been upgraded from 0.64 to 0.66 |
109 | ||
110 | Resolves an issue with splitting Win32 command lines | |
111 | and documentation enhancements. | |
112 | ||
113 | =item * | |
114 | ||
68adb2b0 CBW |
115 | C<Unicode::Collate> has been upgraded from 0.67 to 0.68 |
116 | ||
117 | =item * | |
118 | ||
3a5c9134 CBW |
119 | XXX |
120 | ||
121 | =back | |
122 | ||
123 | =head2 Removed Modules and Pragmata | |
124 | ||
125 | =over 4 | |
126 | ||
127 | =item * | |
128 | ||
129 | XXX | |
130 | ||
131 | =back | |
132 | ||
133 | =head1 Documentation | |
134 | ||
135 | XXX Changes to files in F<pod/> go here. Consider grouping entries by | |
136 | file and be sure to link to the appropriate page, e.g. L<perlfunc>. | |
137 | ||
138 | =head2 New Documentation | |
139 | ||
140 | XXX Changes which create B<new> files in F<pod/> go here. | |
141 | ||
142 | =head3 L<XXX> | |
143 | ||
144 | XXX Description of the purpose of the new file here | |
145 | ||
146 | =head2 Changes to Existing Documentation | |
147 | ||
148 | XXX Changes which significantly change existing files in F<pod/> go here. | |
149 | However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics> | |
150 | section. | |
151 | ||
152 | =head3 L<XXX> | |
153 | ||
154 | =over 4 | |
155 | ||
156 | =item * | |
157 | ||
158 | XXX Description of the change here | |
159 | ||
160 | =back | |
161 | ||
162 | =head1 Diagnostics | |
163 | ||
164 | The following additions or changes have been made to diagnostic output, | |
165 | including warnings and fatal error messages. For the complete list of | |
166 | diagnostic messages, see L<perldiag>. | |
167 | ||
168 | XXX New or changed warnings emitted by the core's C<C> code go here. Also | |
169 | include any changes in L<perldiag> that reconcile it to the C<C> code. | |
170 | ||
171 | [ Within each section, list entries as a =item entry ] | |
172 | ||
173 | =head2 New Diagnostics | |
174 | ||
175 | XXX Newly added diagnostic messages go here | |
176 | ||
177 | =over 4 | |
178 | ||
179 | =item * | |
180 | ||
181 | XXX | |
182 | ||
183 | =back | |
184 | ||
185 | =head2 Changes to Existing Diagnostics | |
186 | ||
187 | XXX Changes (i.e. rewording) of diagnostic messages go here | |
188 | ||
189 | =over 4 | |
190 | ||
191 | =item * | |
192 | ||
193 | XXX | |
194 | ||
195 | =back | |
196 | ||
197 | =head1 Utility Changes | |
198 | ||
199 | XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go | |
200 | here. Most of these are built within the directories F<utils> and F<x2p>. | |
201 | ||
202 | [ List utility changes as a =head3 entry for each utility and =item | |
203 | entries for each change | |
204 | Use L<XXX> with program names to get proper documentation linking. ] | |
205 | ||
206 | =head3 L<XXX> | |
207 | ||
208 | =over 4 | |
209 | ||
210 | =item * | |
211 | ||
212 | XXX | |
213 | ||
214 | =back | |
215 | ||
216 | =head1 Configuration and Compilation | |
217 | ||
218 | XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools | |
219 | go here. Any other changes to the Perl build process should be listed here. | |
220 | However, any platform-specific changes should be listed in the | |
221 | L</Platform Support> section, instead. | |
222 | ||
223 | [ List changes as a =item entry ]. | |
224 | ||
225 | =over 4 | |
226 | ||
227 | =item * | |
228 | ||
229 | XXX | |
230 | ||
231 | =back | |
232 | ||
233 | =head1 Testing | |
234 | ||
235 | XXX Any significant changes to the testing of a freshly built perl should be | |
236 | listed here. Changes which create B<new> files in F<t/> go here as do any | |
237 | large changes to the testing harness (e.g. when parallel testing was added). | |
238 | Changes to existing files in F<t/> aren't worth summarising, although the bugs | |
239 | that they represent may be covered elsewhere. | |
240 | ||
241 | [ List each test improvement as a =item entry ] | |
242 | ||
243 | =over 4 | |
244 | ||
245 | =item * | |
246 | ||
247 | XXX | |
248 | ||
249 | =back | |
250 | ||
251 | =head1 Platform Support | |
252 | ||
253 | XXX Any changes to platform support should be listed in the sections below. | |
254 | ||
255 | [ Within the sections, list each platform as a =item entry with specific | |
256 | changes as paragraphs below it. ] | |
257 | ||
258 | =head2 New Platforms | |
259 | ||
260 | XXX List any platforms that this version of perl compiles on, that previous | |
261 | versions did not. These will either be enabled by new files in the F<hints/> | |
262 | directories, or new subdirectories and F<README> files at the top level of the | |
263 | source tree. | |
264 | ||
265 | =over 4 | |
266 | ||
267 | =item XXX-some-platform | |
268 | ||
269 | XXX | |
270 | ||
271 | =back | |
272 | ||
273 | =head2 Discontinued Platforms | |
274 | ||
275 | XXX List any platforms that this version of perl no longer compiles on. | |
276 | ||
277 | =over 4 | |
278 | ||
279 | =item XXX-some-platform | |
280 | ||
281 | XXX | |
282 | ||
283 | =back | |
284 | ||
285 | =head2 Platform-Specific Notes | |
286 | ||
287 | XXX List any changes for specific platforms. This could include configuration | |
288 | and compilation changes or changes in portability/compatibility. However, | |
289 | changes within modules for platforms should generally be listed in the | |
290 | L</Modules and Pragmata> section. | |
291 | ||
292 | =over 4 | |
293 | ||
294 | =item XXX-some-platform | |
295 | ||
296 | XXX | |
297 | ||
298 | =back | |
299 | ||
300 | =head1 Internal Changes | |
301 | ||
302 | XXX Changes which affect the interface available to C<XS> code go here. | |
303 | Other significant internal changes for future core maintainers should | |
304 | be noted as well. | |
305 | ||
306 | [ List each test improvement as a =item entry ] | |
307 | ||
308 | =over 4 | |
309 | ||
310 | =item * | |
311 | ||
312 | XXX | |
313 | ||
314 | =back | |
315 | ||
316 | =head1 Selected Bug Fixes | |
317 | ||
318 | XXX Important bug fixes in the core language are summarised here. | |
319 | Bug fixes in files in F<ext/> and F<lib/> are best summarised in | |
320 | L</Modules and Pragmata>. | |
321 | ||
322 | [ List each fix as a =item entry ] | |
323 | ||
324 | =over 4 | |
325 | ||
326 | =item * | |
327 | ||
328 | XXX | |
329 | ||
330 | =back | |
331 | ||
332 | =head1 Known Problems | |
333 | ||
334 | XXX Descriptions of platform agnostic bugs we know we can't fix go here. Any | |
335 | tests that had to be C<TODO>ed for the release would be noted here, unless | |
336 | they were specific to a particular platform (see below). | |
337 | ||
338 | This is a list of some significant unfixed bugs, which are regressions | |
339 | from either 5.XXX.XXX or 5.XXX.XXX. | |
340 | ||
341 | [ List each fix as a =item entry ] | |
342 | ||
343 | =over 4 | |
344 | ||
345 | =item * | |
346 | ||
2283d326 KW |
347 | A number of bugs with regular expression bracketed character classes |
348 | have been fixed, mostly having to do with matching characters in the | |
349 | non-ASCII Latin-1 range. | |
3a5c9134 CBW |
350 | |
351 | =back | |
352 | ||
353 | =head1 Obituary | |
354 | ||
355 | XXX If any significant core contributor has died, we've added a short obituary | |
356 | here. | |
357 | ||
358 | =head1 Acknowledgements | |
359 | ||
360 | XXX The list of people to thank goes here. | |
361 | ||
362 | =head1 Reporting Bugs | |
363 | ||
364 | If you find what you think is a bug, you might check the articles | |
365 | recently posted to the comp.lang.perl.misc newsgroup and the perl | |
366 | bug database at http://rt.perl.org/perlbug/ . There may also be | |
367 | information at http://www.perl.org/ , the Perl Home Page. | |
368 | ||
369 | If you believe you have an unreported bug, please run the L<perlbug> | |
370 | program included with your release. Be sure to trim your bug down | |
371 | to a tiny but sufficient test case. Your bug report, along with the | |
372 | output of C<perl -V>, will be sent off to perlbug@perl.org to be | |
373 | analysed by the Perl porting team. | |
374 | ||
375 | If the bug you are reporting has security implications, which make it | |
376 | inappropriate to send to a publicly archived mailing list, then please send | |
377 | it to perl5-security-report@perl.org. This points to a closed subscription | |
378 | unarchived mailing list, which includes all the core committers, who be able | |
379 | to help assess the impact of issues, figure out a resolution, and help | |
380 | co-ordinate the release of patches to mitigate or fix the problem across all | |
381 | platforms on which Perl is supported. Please only use this address for | |
382 | security issues in the Perl core, not for modules independently | |
383 | distributed on CPAN. | |
384 | ||
385 | =head1 SEE ALSO | |
386 | ||
387 | The F<Changes> file for an explanation of how to view exhaustive details | |
388 | on what changed. | |
389 | ||
390 | The F<INSTALL> file for how to build Perl. | |
391 | ||
392 | The F<README> file for general stuff. | |
393 | ||
394 | The F<Artistic> and F<Copying> files for copyright information. | |
395 | ||
396 | =cut |