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