perldelta for ed5044532 and 858e29b9 (Carp)
[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 XXX needs
6 to be processed before release. ]
7
8 perldelta - what is new for perl v5.17.5
9
10 =head1 DESCRIPTION
11
12 This document describes differences between the 5.17.4 release and the 5.17.5
13 release.
14
15 If you are upgrading from an earlier release such as 5.17.3, first read
16 L<perl5174delta>, which describes differences between 5.17.3 and 5.17.4.
17
18 =head1 Notice
19
20 XXX Any important notices here
21
22 =head1 Core Enhancements
23
24 XXX New core language features go here.  Summarize user-visible core language
25 enhancements.  Particularly prominent performance optimisations could go
26 here, but most should go in the L</Performance Enhancements> section.
27
28 [ List each enhancement as a =head2 entry ]
29
30 =head2 Upgrade to Unicode 6.2
31
32 Perl now supports the final version of Unicode 6.2.  Earlier releases in
33 the 5.17 series supported Unicode 6.2 beta versions.  There were no
34 substantive changes in the final Unicode 6.2 version from the most
35 recent beta, included in Perl 5.17.4.  A list of changes from Unicode
36 6.1 is at L<http://www.unicode.org/versions/Unicode6.2.0>.
37
38 =head1 Security
39
40 XXX Any security-related notices go here.  In particular, any security
41 vulnerabilities closed should be noted here rather than in the
42 L</Selected Bug Fixes> section.
43
44 [ List each security issue as a =head2 entry ]
45
46 =head1 Incompatible Changes
47
48 XXX For a release on a stable branch, this section aspires to be:
49
50     There are no changes intentionally incompatible with 5.XXX.XXX
51     If any exist, they are bugs, and we request that you submit a
52     report.  See L</Reporting Bugs> below.
53
54 [ List each incompatible change as a =head2 entry ]
55
56 =head1 Deprecations
57
58 XXX Any deprecated features, syntax, modules etc. should be listed here.  In
59 particular, deprecated modules should be listed here even if they are listed as
60 an updated module in the L</Modules and Pragmata> section.
61
62 [ List each deprecation as a =head2 entry ]
63
64 =head1 Performance Enhancements
65
66 XXX Changes which enhance performance without changing behaviour go here.
67 There may well be none in a stable release.
68
69 [ List each enhancement as a =item entry ]
70
71 =over 4
72
73 =item *
74
75 XXX
76
77 =back
78
79 =head1 Modules and Pragmata
80
81 XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
82 go here.  If Module::CoreList is updated, generate an initial draft of the
83 following sections using F<Porting/corelist-perldelta.pl>, which prints stub
84 entries to STDOUT.  Results can be pasted in place of the '=head2' entries
85 below.  A paragraph summary for important changes should then be added by hand.
86 In an ideal world, dual-life modules would have a F<Changes> file that could be
87 cribbed.
88
89 [ Within each section, list entries as a =item entry ]
90
91 =head2 New Modules and Pragmata
92
93 =over 4
94
95 =item *
96
97 XXX
98
99 =back
100
101 =head2 Updated Modules and Pragmata
102
103 =over 4
104
105 =item *
106
107 L<Carp> has been upgraded from version 1.26 to 1.27.  The longmess()
108 and shortmess() functions are now documented.
109
110 =back
111
112 =head2 Removed Modules and Pragmata
113
114 =over 4
115
116 =item *
117
118 XXX
119
120 =back
121
122 =head1 Documentation
123
124 XXX Changes to files in F<pod/> go here.  Consider grouping entries by
125 file and be sure to link to the appropriate page, e.g. L<perlfunc>.
126
127 =head2 New Documentation
128
129 XXX Changes which create B<new> files in F<pod/> go here.
130
131 =head3 L<XXX>
132
133 XXX Description of the purpose of the new file here
134
135 =head2 Changes to Existing Documentation
136
137 XXX Changes which significantly change existing files in F<pod/> go here.
138 However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
139 section.
140
141 =head3 L<XXX>
142
143 =over 4
144
145 =item *
146
147 XXX Description of the change here
148
149 =back
150
151 =head1 Diagnostics
152
153 The following additions or changes have been made to diagnostic output,
154 including warnings and fatal error messages.  For the complete list of
155 diagnostic messages, see L<perldiag>.
156
157 XXX New or changed warnings emitted by the core's C<C> code go here.  Also
158 include any changes in L<perldiag> that reconcile it to the C<C> code.
159
160 =head2 New Diagnostics
161
162 XXX Newly added diagnostic messages go under here, separated into New Errors
163 and New Warnings
164
165 =head3 New Errors
166
167 =over 4
168
169 =item *
170
171 XXX L<message|perldiag/"message">
172
173 =back
174
175 =head3 New Warnings
176
177 =over 4
178
179 =item *
180
181 XXX L<message|perldiag/"message">
182
183 =back
184
185 =head2 Changes to Existing Diagnostics
186
187 XXX Changes (i.e. rewording) of diagnostic messages go here
188
189 =over 4
190
191 =item *
192
193 XXX Describe change here
194
195 =back
196
197 =head1 Utility Changes
198
199 XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here.
200 Most of these are built within the directories F<utils> and F<x2p>.
201
202 [ List utility changes as a =head3 entry for each utility and =item
203 entries for each change
204 Use L<XXX> with program names to get proper documentation linking. ]
205
206 =head3 L<XXX>
207
208 =over 4
209
210 =item *
211
212 XXX
213
214 =back
215
216 =head1 Configuration and Compilation
217
218 XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
219 go here.  Any other changes to the Perl build process should be listed here.
220 However, any platform-specific changes should be listed in the
221 L</Platform Support> section, instead.
222
223 [ List changes as a =item entry ].
224
225 =over 4
226
227 =item *
228
229 XXX
230
231 =back
232
233 =head1 Testing
234
235 XXX Any significant changes to the testing of a freshly built perl should be
236 listed here.  Changes which create B<new> files in F<t/> go here as do any
237 large changes to the testing harness (e.g. when parallel testing was added).
238 Changes to existing files in F<t/> aren't worth summarizing, although the bugs
239 that they represent may be covered elsewhere.
240
241 [ List each test improvement as a =item entry ]
242
243 =over 4
244
245 =item *
246
247 XXX
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.  Other
303 significant internal changes for future core maintainers should be noted as
304 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 summarized here.  Bug fixes in
319 files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>.
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 Known Problems
332
333 XXX Descriptions of platform agnostic bugs we know we can't fix go here.  Any
334 tests that had to be C<TODO>ed for the release would be noted here.  Unfixed
335 platform specific bugs also go here.
336
337 [ List each fix as a =item entry ]
338
339 =over 4
340
341 =item *
342
343 XXX
344
345 =back
346
347 =head1 Obituary
348
349 XXX If any significant core contributor has died, we've added a short obituary
350 here.
351
352 =head1 Acknowledgements
353
354 XXX Generate this with:
355
356   perl Porting/acknowledgements.pl v5.17.4..HEAD
357
358 =head1 Reporting Bugs
359
360 If you find what you think is a bug, you might check the articles recently
361 posted to the comp.lang.perl.misc newsgroup and the perl bug database at
362 http://rt.perl.org/perlbug/ .  There may also be information at
363 http://www.perl.org/ , the Perl Home Page.
364
365 If you believe you have an unreported bug, please run the L<perlbug> program
366 included with your release.  Be sure to trim your bug down to a tiny but
367 sufficient test case.  Your bug report, along with the output of C<perl -V>,
368 will be sent off to perlbug@perl.org to be analysed by the Perl porting team.
369
370 If the bug you are reporting has security implications, which make it
371 inappropriate to send to a publicly archived mailing list, then please send it
372 to perl5-security-report@perl.org.  This points to a closed subscription
373 unarchived mailing list, which includes all the core committers, who will be
374 able to help assess the impact of issues, figure out a resolution, and help
375 co-ordinate the release of patches to mitigate or fix the problem across all
376 platforms on which Perl is supported.  Please only use this address for
377 security issues in the Perl core, not for modules independently distributed on
378 CPAN.
379
380 =head1 SEE ALSO
381
382 The F<Changes> file for an explanation of how to view exhaustive details on
383 what changed.
384
385 The F<INSTALL> file for how to build Perl.
386
387 The F<README> file for general stuff.
388
389 The F<Artistic> and F<Copying> files for copyright information.
390
391 =cut