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