Commit | Line | Data |
---|---|---|
e90f0e29 DG |
1 | =encoding utf8 |
2 | ||
09d86ea5 FR |
3 | =for rafl |
4 | changelogged up to commit 2ea2ea91 | |
5 | * PERL_STATIC_INLINE might want to be mentioned | |
6 | * perl5db.pl | |
7 | ** what's with the one change but many changelog entries? | |
8 | ** why a new version in the changelog but no version bump? | |
9 | ||
e90f0e29 DG |
10 | =head1 NAME |
11 | ||
12 | [ this is a template for a new perldelta file. Any text flagged as | |
13 | XXX needs to be processed before release. ] | |
14 | ||
15 | perldelta - what is new for perl v5.13.4 | |
16 | ||
17 | =head1 DESCRIPTION | |
18 | ||
19 | This document describes differences between the 5.13.4 release and | |
20 | the 5.13.3 release. | |
21 | ||
22 | If you are upgrading from an earlier release such as 5.13.2, first read | |
23 | L<perl5133delta>, which describes differences between 5.13.2 and | |
24 | 5.13.3. | |
25 | ||
26 | =head1 Notice | |
27 | ||
28 | XXX Any important notices here | |
29 | ||
30 | =head1 Core Enhancements | |
31 | ||
32 | XXX New core language features go here. Summarise user-visible core language | |
33 | enhancements. Particularly prominent performance optimisations could go | |
34 | here, but most should go in the L</Performance Enhancements> section. | |
35 | ||
36 | [ List each enhancement as a =head2 entry ] | |
37 | ||
38 | =head1 Security | |
39 | ||
40 | XXX Any security-related notices go here. In particular, any security | |
41 | vulnerabilities closed should be noted here rather than in the | |
42 | L</Selected Bug Fixes> section. | |
43 | ||
44 | [ List each security issue as a =head2 entry ] | |
45 | ||
46 | =head1 Incompatible Changes | |
47 | ||
48 | XXX For a release on a stable branch, this section aspires to be: | |
49 | ||
50 | There are no changes intentionally incompatible with 5.XXX.XXX. If any | |
51 | exist, they are bugs and reports are welcome. | |
52 | ||
53 | [ List each incompatible change as a =head2 entry ] | |
54 | ||
55 | =head1 Deprecations | |
56 | ||
57 | XXX Any deprecated features, syntax, modules etc. should be listed here. | |
58 | In particular, deprecated modules should be listed here even if they are | |
59 | listed as an updated module in the L</Modules and Pragmata> section. | |
60 | ||
61 | [ List each deprecation as a =head2 entry ] | |
62 | ||
63 | =head1 Performance Enhancements | |
64 | ||
65 | XXX Changes which enhance performance without changing behaviour go here. There | |
66 | may well be none in a stable release. | |
67 | ||
68 | [ List each enhancement as a =item * entry ] | |
69 | ||
70 | =over 4 | |
71 | ||
72 | =item * | |
73 | ||
74 | XXX | |
75 | ||
76 | =back | |
77 | ||
78 | =head1 Modules and Pragmata | |
79 | ||
80 | XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/> | |
81 | go here. If Module::CoreList is updated, generate an initial draft of the | |
82 | following sections using F<Porting/corelist-perldelta.pl>, which prints stub | |
83 | entries to STDOUT. Results can be pasted in place of the '=head2' entries | |
84 | below. A paragraph summary for important changes should then be added by hand. | |
85 | In an ideal world, dual-life modules would have a F<Changes> file that could be | |
86 | cribbed. | |
87 | ||
88 | [ Within each section, list entries as a =item NAME entry ] | |
89 | ||
90 | =head2 New Modules and Pragmata | |
91 | ||
92 | =over 4 | |
93 | ||
94 | =item * | |
95 | ||
96 | XXX | |
97 | ||
98 | =back | |
99 | ||
100 | =head2 Updated Modules and Pragmata | |
101 | ||
102 | =over 4 | |
103 | ||
09d86ea5 | 104 | =item C<Carp> |
e90f0e29 | 105 | |
09d86ea5 FR |
106 | Upgraded from version 1.16 to 1.18. |
107 | ||
108 | L<Carp> now detects incomplete L<caller()|perlfunc/"caller EXPR"> overrides and | |
109 | avoids using bogus C<@DB::args>. This fixes certain cases of C<Bizarre copy of | |
110 | ARRAY> caused by modules overriding C<caller()> incorrectly. | |
111 | ||
112 | =item C<File::Spec> | |
113 | ||
114 | Upgraded from version 3.31 to 3.31_01. | |
115 | ||
116 | Various issues in L<File::Spec::VMS> have been fixed. | |
e90f0e29 DG |
117 | |
118 | =back | |
119 | ||
120 | =head2 Removed Modules and Pragmata | |
121 | ||
122 | =over 4 | |
123 | ||
124 | =item * | |
125 | ||
126 | XXX | |
127 | ||
128 | =back | |
129 | ||
130 | =head1 Documentation | |
131 | ||
132 | XXX Changes to files in F<pod/> go here. Consider grouping entries by | |
133 | file and be sure to link to the appropriate page, e.g. L<perlfunc>. | |
134 | ||
135 | =head2 New Documentation | |
136 | ||
137 | XXX Changes which create B<new> files in F<pod/> go here. | |
138 | ||
139 | =head3 L<XXX> | |
140 | ||
141 | XXX Description of the purpose of the new file here | |
142 | ||
143 | =head2 Changes to Existing Documentation | |
144 | ||
145 | XXX Changes which significantly change existing files in F<pod/> go here. | |
146 | However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics> | |
147 | section. | |
148 | ||
09d86ea5 | 149 | =head3 L<perlport> |
e90f0e29 DG |
150 | |
151 | =over 4 | |
152 | ||
153 | =item * | |
154 | ||
09d86ea5 FR |
155 | Documented a L<limitation|perlport/alarm> of L<alarm()|perlfunc/"alarm SECONDS"> |
156 | on Win32. | |
e90f0e29 DG |
157 | |
158 | =back | |
159 | ||
160 | =head1 Diagnostics | |
161 | ||
162 | The following additions or changes have been made to diagnostic output, | |
163 | including warnings and fatal error messages. For the complete list of | |
164 | diagnostic messages, see L<perldiag>. | |
165 | ||
166 | XXX New or changed warnings emitted by the core's C<C> code go here. Also | |
167 | include any changes in L<perldiag> that reconcile it to the C<C> code. | |
168 | ||
169 | [ Within each section, list entries as a =item entry ] | |
170 | ||
171 | =head2 New Diagnostics | |
172 | ||
173 | XXX Newly added diagnostic messages go here | |
174 | ||
175 | =over 4 | |
176 | ||
177 | =item * | |
178 | ||
179 | XXX | |
180 | ||
181 | =back | |
182 | ||
183 | =head2 Changes to Existing Diagnostics | |
184 | ||
185 | XXX Changes (i.e. rewording) of diagnostic messages go here | |
186 | ||
187 | =over 4 | |
188 | ||
189 | =item * | |
190 | ||
191 | XXX | |
192 | ||
193 | =back | |
194 | ||
195 | =head1 Utility Changes | |
196 | ||
197 | XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go | |
198 | here. Most of these are built within the directories F<utils> and F<x2p>. | |
199 | ||
200 | [ List utility changes as a =head3 entry for each utility and =item | |
201 | entries for each change | |
202 | Use L<XXX> with program names to get proper documentation linking. ] | |
203 | ||
204 | =head3 L<XXX> | |
205 | ||
206 | =over 4 | |
207 | ||
208 | =item * | |
209 | ||
210 | XXX | |
211 | ||
212 | =back | |
213 | ||
214 | =head1 Configuration and Compilation | |
215 | ||
216 | XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools | |
217 | go here. Any other changes to the Perl build process should be listed here. | |
218 | However, any platform-specific changes should be listed in the | |
219 | L</Platform Support> section, instead. | |
220 | ||
221 | [ List changes as a =item entry ]. | |
222 | ||
223 | =over 4 | |
224 | ||
225 | =item * | |
226 | ||
09d86ea5 | 227 | Improve compatibility with C<C++> compilers. |
e90f0e29 DG |
228 | |
229 | =back | |
230 | ||
231 | =head1 Testing | |
232 | ||
233 | XXX Any significant changes to the testing of a freshly built perl should be | |
234 | listed here. Changes which create B<new> files in F<t/> go here as do any | |
235 | large changes to the testing harness (e.g. when parallel testing was added). | |
236 | Changes to existing files in F<t/> aren't worth summarising, although the bugs | |
237 | that they represent may be covered elsewhere. | |
238 | ||
239 | [ List each test improvement as a =item entry ] | |
240 | ||
241 | =over 4 | |
242 | ||
243 | =item * | |
244 | ||
245 | XXX | |
246 | ||
247 | =back | |
248 | ||
249 | =head1 Platform Support | |
250 | ||
251 | XXX Any changes to platform support should be listed in the sections below. | |
252 | ||
253 | [ Within the sections, list each platform as a =item entry with specific | |
254 | changes as paragraphs below it. ] | |
255 | ||
256 | =head2 New Platforms | |
257 | ||
258 | XXX List any platforms that this version of perl compiles on, that previous | |
259 | versions did not. These will either be enabled by new files in the F<hints/> | |
260 | directories, or new subdirectories and F<README> files at the top level of the | |
261 | source tree. | |
262 | ||
263 | =over 4 | |
264 | ||
265 | =item XXX-some-platform | |
266 | ||
267 | XXX | |
268 | ||
269 | =back | |
270 | ||
271 | =head2 Discontinued Platforms | |
272 | ||
273 | XXX List any platforms that this version of perl no longer compiles on. | |
274 | ||
275 | =over 4 | |
276 | ||
277 | =item XXX-some-platform | |
278 | ||
279 | XXX | |
280 | ||
281 | =back | |
282 | ||
283 | =head2 Platform-Specific Notes | |
284 | ||
285 | XXX List any changes for specific platforms. This could include configuration | |
286 | and compilation changes or changes in portability/compatibility. However, | |
287 | changes within modules for platforms should generally be listed in the | |
288 | L</Modules and Pragmata> section. | |
289 | ||
290 | =over 4 | |
291 | ||
09d86ea5 | 292 | =item Win32 |
e90f0e29 | 293 | |
09d86ea5 FR |
294 | =over 4 |
295 | ||
296 | =item * | |
297 | ||
298 | Fixed a possible hang in F<t/op/readline.t>. | |
299 | ||
300 | =item * | |
301 | ||
302 | Fixed Makefile for SDK2003SP1 compilers. | |
303 | ||
304 | =back | |
e90f0e29 DG |
305 | |
306 | =back | |
307 | ||
308 | =head1 Internal Changes | |
309 | ||
310 | XXX Changes which affect the interface available to C<XS> code go here. | |
311 | Other significant internal changes for future core maintainers should | |
312 | be noted as well. | |
313 | ||
314 | [ List each test improvement as a =item entry ] | |
315 | ||
316 | =over 4 | |
317 | ||
09d86ea5 | 318 | =item Removed C<PERL_POLLUTE> |
e90f0e29 | 319 | |
09d86ea5 FR |
320 | The option to define C<PERL_POLLUTE> to expose older 5.005 symbols for backwards |
321 | compatibility has been removed. It's use was always discouraged, and MakeMaker | |
322 | contains a more specific escape hatch: | |
323 | ||
324 | perl Makefile.PL POLLUTE=1 | |
325 | ||
326 | This can be used for modules that have not been upgraded to 5.6 naming | |
327 | conventions (and really should be completely obsolete by now). | |
328 | ||
329 | =item Declare API incompatibility between blead releases | |
330 | ||
331 | Only stable releases (5.10.x, 5.12.x, 5.14.x, ...) guarantee binary | |
332 | compatibility with each other, while blead releases (5.13.x, 5.15.x, ...) often | |
333 | break this compatibility. However, prior to perl 5.13.4, all blead releases had | |
334 | the same C<PERL_API_REVISION>, C<PERL_API_VERSION>, and C<PERL_API_SUBVERSION>, | |
335 | effectively declaring them as binary compatible, which they weren't. From now | |
336 | on, blead releases will have a C<PERL_API_SUBVERSION> equal to their | |
337 | C<PERL_SUBVERSION>, explicitly marking them as incompatible with each other. | |
338 | ||
339 | Maintainance releases of stable perl's will continue to make no intentionally | |
340 | incompatible changes. | |
e90f0e29 DG |
341 | |
342 | =back | |
343 | ||
344 | =head1 Selected Bug Fixes | |
345 | ||
346 | XXX Important bug fixes in the core language are summarised here. | |
347 | Bug fixes in files in F<ext/> and F<lib/> are best summarised in | |
348 | L</Modules and Pragmata>. | |
349 | ||
350 | [ List each fix as a =item entry ] | |
351 | ||
352 | =over 4 | |
353 | ||
354 | =item * | |
355 | ||
09d86ea5 FR |
356 | Fixed possible memory leak when using L<caller()|perlfunc/"caller EXPR"> to set |
357 | C<@DB::args>. | |
358 | ||
359 | =item * | |
360 | ||
361 | Several memory leaks when loading XS modules were fixed. | |
e90f0e29 DG |
362 | |
363 | =back | |
364 | ||
365 | =head1 Known Problems | |
366 | ||
367 | XXX Descriptions of platform agnostic bugs we know we can't fix go here. Any | |
368 | tests that had to be C<TODO>ed for the release would be noted here, unless | |
369 | they were specific to a particular platform (see below). | |
370 | ||
371 | This is a list of some significant unfixed bugs, which are regressions | |
372 | from either 5.XXX.XXX or 5.XXX.XXX. | |
373 | ||
374 | [ List each fix as a =item entry ] | |
375 | ||
376 | =over 4 | |
377 | ||
378 | =item * | |
379 | ||
380 | XXX | |
381 | ||
382 | =back | |
383 | ||
384 | =head1 Obituary | |
385 | ||
386 | XXX If any significant core contributor has died, we've added a short obituary | |
387 | here. | |
388 | ||
389 | =head1 Acknowledgements | |
390 | ||
391 | XXX The list of people to thank goes here. | |
392 | ||
393 | =head1 Reporting Bugs | |
394 | ||
395 | If you find what you think is a bug, you might check the articles | |
396 | recently posted to the comp.lang.perl.misc newsgroup and the perl | |
397 | bug database at http://rt.perl.org/perlbug/ . There may also be | |
398 | information at http://www.perl.org/ , the Perl Home Page. | |
399 | ||
400 | If you believe you have an unreported bug, please run the B<perlbug> | |
401 | program included with your release. Be sure to trim your bug down | |
402 | to a tiny but sufficient test case. Your bug report, along with the | |
403 | output of C<perl -V>, will be sent off to perlbug@perl.org to be | |
404 | analysed by the Perl porting team. | |
405 | ||
406 | If the bug you are reporting has security implications, which make it | |
407 | inappropriate to send to a publicly archived mailing list, then please send | |
408 | it to perl5-security-report@perl.org. This points to a closed subscription | |
409 | unarchived mailing list, which includes all the core committers, who be able | |
410 | to help assess the impact of issues, figure out a resolution, and help | |
411 | co-ordinate the release of patches to mitigate or fix the problem across all | |
412 | platforms on which Perl is supported. Please only use this address for | |
413 | security issues in the Perl core, not for modules independently | |
414 | distributed on CPAN. | |
415 | ||
416 | =head1 SEE ALSO | |
417 | ||
418 | The F<Changes> file for an explanation of how to view exhaustive details | |
419 | on what changed. | |
420 | ||
421 | The F<INSTALL> file for how to build Perl. | |
422 | ||
423 | The F<README> file for general stuff. | |
424 | ||
425 | The F<Artistic> and F<Copying> files for copyright information. | |
426 | ||
427 | =cut |