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