This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
ba6590513c017c046e719ca2d2936af999615375
[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.4
9
10 =head1 DESCRIPTION
11
12 This document describes differences between the 5.15.3 release and
13 the 5.15.4 release.
14
15 If you are upgrading from an earlier release such as 5.15.3, first read
16 L<perl5153delta>, which describes differences between 5.15.3 and
17 5.15.4.
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
44     If any 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 L<XXX> has been upgraded from version 0.69 to version 0.70.
100
101 =back
102
103 =head2 Removed Modules and Pragmata
104
105 =over 4
106
107 =item *
108
109 XXX
110
111 =back
112
113 =head1 Documentation
114
115 XXX Changes to files in F<pod/> go here.  Consider grouping entries by
116 file and be sure to link to the appropriate page, e.g. L<perlfunc>.
117
118 =head2 New Documentation
119
120 XXX Changes which create B<new> files in F<pod/> go here.
121
122 =head3 L<XXX>
123
124 XXX Description of the purpose of the new file here
125
126 =head2 Changes to Existing Documentation
127
128 XXX Changes which significantly change existing files in F<pod/> go here.
129 However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
130 section.
131
132 =head3 L<XXX>
133
134 =over 4
135
136 =item *
137
138 XXX Description of the change here
139
140 =back
141
142 =head1 Diagnostics
143
144 The following additions or changes have been made to diagnostic output,
145 including warnings and fatal error messages.  For the complete list of
146 diagnostic messages, see L<perldiag>.
147
148 XXX New or changed warnings emitted by the core's C<C> code go here. Also
149 include any changes in L<perldiag> that reconcile it to the C<C> code.
150
151 [ Within each section, list entries as a =item entry that links to perldiag,
152   e.g.
153
154   =item *
155
156   L<Invalid version object|perldiag/"Invalid version object">
157 ]
158
159 =head2 New Diagnostics
160
161 XXX Newly added diagnostic messages go here
162
163 =head3 New Errors
164
165 =over 4
166
167 =item *
168
169 XXX L<message|perldiag/"message">
170
171 =back
172
173 =head3 New Warnings
174
175 =over 4
176
177 =item *
178
179 XXX L<message|perldiag/"message">
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 Describe change here
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
227 XXX
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 F<t/porting/checkcfgvar.t> now tests that all config.sh-style files are
246 complete. These are used by the various non-*nix to generate their
247 F<config.h>, and an incomplete input file will generate invalid output.
248
249 =back
250
251 =head1 Platform Support
252
253 XXX Any changes to platform support should be listed in the sections below.
254
255 [ Within the sections, list each platform as a =item entry with specific
256 changes as paragraphs below it. ]
257
258 =head2 New Platforms
259
260 XXX List any platforms that this version of perl compiles on, that previous
261 versions did not. These will either be enabled by new files in the F<hints/>
262 directories, or new subdirectories and F<README> files at the top level of the
263 source tree.
264
265 =over 4
266
267 =item XXX-some-platform
268
269 XXX
270
271 =back
272
273 =head2 Discontinued Platforms
274
275 XXX List any platforms that this version of perl no longer compiles on.
276
277 =over 4
278
279 =item XXX-some-platform
280
281 XXX
282
283 =back
284
285 =head2 Platform-Specific Notes
286
287 XXX List any changes for specific platforms. This could include configuration
288 and compilation changes or changes in portability/compatibility.  However,
289 changes within modules for platforms should generally be listed in the
290 L</Modules and Pragmata> section.
291
292 =over 4
293
294 =item XXX-some-platform
295
296 XXX
297
298 =back
299
300 =head1 Internal Changes
301
302 XXX Changes which affect the interface available to C<XS> code go here.
303 Other significant internal changes for future core maintainers should
304 be noted as well.
305
306 [ List each change as a =item entry ]
307
308 =over 4
309
310 =item *
311
312 XXX
313
314 =back
315
316 =head1 Selected Bug Fixes
317
318 XXX Important bug fixes in the core language are summarised here.
319 Bug fixes in files in F<ext/> and F<lib/> are best summarised in
320 L</Modules and Pragmata>.
321
322 [ List each fix as a =item entry ]
323
324 =over 4
325
326 =item *
327
328 XXX
329
330 =back
331
332 =head1 Known Problems
333
334 XXX Descriptions of platform agnostic bugs we know we can't fix go here. Any
335 tests that had to be C<TODO>ed for the release would be noted here, unless
336 they were specific to a particular platform (see below).
337
338 This is a list of some significant unfixed bugs, which are regressions
339 from either 5.XXX.XXX or 5.XXX.XXX.
340
341 [ List each fix as a =item entry ]
342
343 =over 4
344
345 =item *
346
347 XXX
348
349 =back
350
351 =head1 Obituary
352
353 XXX If any significant core contributor has died, we've added a short obituary
354 here.
355
356 =head1 Acknowledgements
357
358 XXX Generate this with:
359
360   perl Porting/acknowledgements.pl v5.15.3..HEAD
361
362 =head1 Reporting Bugs
363
364 If you find what you think is a bug, you might check the articles
365 recently posted to the comp.lang.perl.misc newsgroup and the perl
366 bug database at http://rt.perl.org/perlbug/ .  There may also be
367 information at http://www.perl.org/ , the Perl Home Page.
368
369 If you believe you have an unreported bug, please run the L<perlbug>
370 program included with your release.  Be sure to trim your bug down
371 to a tiny but sufficient test case.  Your bug report, along with the
372 output of C<perl -V>, will be sent off to perlbug@perl.org to be
373 analysed by the Perl porting team.
374
375 If the bug you are reporting has security implications, which make it
376 inappropriate to send to a publicly archived mailing list, then please send
377 it to perl5-security-report@perl.org. This points to a closed subscription
378 unarchived mailing list, which includes
379 all the core committers, who will be able
380 to help assess the impact of issues, figure out a resolution, and help
381 co-ordinate the release of patches to mitigate or fix the problem across all
382 platforms on which Perl is supported. Please only use this address for
383 security issues in the Perl core, not for modules independently
384 distributed on CPAN.
385
386 =head1 SEE ALSO
387
388 The F<Changes> file for an explanation of how to view exhaustive details
389 on what changed.
390
391 The F<INSTALL> file for how to build Perl.
392
393 The F<README> file for general stuff.
394
395 The F<Artistic> and F<Copying> files for copyright information.
396
397 =cut