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