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