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