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