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