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