This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
1a17400034d820540020cbebf68f7bb4671bcdff
[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.10
9
10 =head1 DESCRIPTION
11
12 This document describes differences between the 5.17.9 release and the 5.17.10
13 release.
14
15 If you are upgrading from an earlier release such as 5.17.8, first read
16 L<perl5179delta>, which describes differences between 5.17.8 and 5.17.9.
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 =head1 Security
31
32 XXX Any security-related notices go here.  In particular, any security
33 vulnerabilities closed should be noted here rather than in the
34 L</Selected Bug Fixes> section.
35
36 [ List each security issue as a =head2 entry ]
37
38 =head1 Incompatible Changes
39
40 =head2 Explicit rules for variable names and identifiers
41
42 Due to an oversight, length-one variable names in 5.16 were completely
43 unrestricted, and opened the door to several kinds of insanity.  As of
44 5.18, these now follow the rules of other identifiers, in addition
45 to accepting characters that match the \p{POSIX_Punct} property.
46
47 There are no longer any differences in the parsing of identifiers specified
48 as $... or ${...}; previously, they were dealt with in different parts of
49 the core, and so had slightly different behavior. For instance,
50 C<${foo:bar}> was a legal variable name.  Since they are now both parsed
51 by the same code, that is no longer the case.
52
53 [ List each incompatible change as a =head2 entry ]
54
55 =head1 Deprecations
56
57 XXX Any deprecated features, syntax, modules etc. should be listed here.  In
58 particular, deprecated modules should be listed here even if they are listed as
59 an updated module in the L</Modules and Pragmata> section.
60
61 [ List each deprecation as a =head2 entry ]
62
63 =head2 PL_sv_objcount
64
65 This interpreter-global variable used to track the total number of
66 Perl objects in the interpreter. It is no longer maintained and will
67 be removed altogether in Perl 5.20.
68
69 =head1 Performance Enhancements
70
71 XXX Changes which enhance performance without changing behaviour go here.
72 There may well be none in a stable release.
73
74 [ List each enhancement as a =item entry ]
75
76 =over 4
77
78 =item *
79
80 XXX
81
82 =back
83
84 =head1 Modules and Pragmata
85
86 XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
87 go here.  If Module::CoreList is updated, generate an initial draft of the
88 following sections using F<Porting/corelist-perldelta.pl>, which prints stub
89 entries to STDOUT.  Results can be pasted in place of the '=head2' entries
90 below.  A paragraph summary for important changes should then be added by hand.
91 In an ideal world, dual-life modules would have a F<Changes> file that could be
92 cribbed.
93
94 [ Within each section, list entries as a =item entry ]
95
96 =head2 New Modules and Pragmata
97
98 =over 4
99
100 =item *
101
102 XXX
103
104 =back
105
106 =head2 Updated Modules and Pragmata
107
108 =over 4
109
110 =item *
111
112 L<Benchmark> has been upgraded from version 1.14 to 1.15.
113
114 This reverts (for now) a change in 1.14 whereby the "too few iterations"
115 message became a warning on STDERR instead of being output on STDOUT. It's
116 now on STDOUT again.
117
118 =item *
119
120 L<Perl::OSType> has been upgraded from version 1.002 to 1.003.
121
122 This fixes a bug detecting the VOS operating system.
123
124 =back
125
126 =head2 Removed Modules and Pragmata
127
128 =over 4
129
130 =item *
131
132 XXX
133
134 =back
135
136 =head1 Documentation
137
138 XXX Changes to files in F<pod/> go here.  Consider grouping entries by
139 file and be sure to link to the appropriate page, e.g. L<perlfunc>.
140
141 =head2 New Documentation
142
143 XXX Changes which create B<new> files in F<pod/> go here.
144
145 =head3 L<XXX>
146
147 XXX Description of the purpose of the new file here
148
149 =head2 Changes to Existing Documentation
150
151 XXX Changes which significantly change existing files in F<pod/> go here.
152 However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
153 section.
154
155 =head3 L<perlrebackslash/\N>
156
157 =over 4
158
159 =item *
160
161 This feature is no longer experimental.
162
163 =back
164
165 =head1 Diagnostics
166
167 The following additions or changes have been made to diagnostic output,
168 including warnings and fatal error messages.  For the complete list of
169 diagnostic messages, see L<perldiag>.
170
171 XXX New or changed warnings emitted by the core's C<C> code go here.  Also
172 include any changes in L<perldiag> that reconcile it to the C<C> code.
173
174 =head2 New Diagnostics
175
176 XXX Newly added diagnostic messages go under here, separated into New Errors
177 and New Warnings
178
179 =head3 New Errors
180
181 =over 4
182
183 =item *
184
185 XXX L<message|perldiag/"message">
186
187 =back
188
189 =head3 New Warnings
190
191 =over 4
192
193 =item *
194
195 XXX L<message|perldiag/"message">
196
197 =back
198
199 =head2 Changes to Existing Diagnostics
200
201 =over 4
202
203 =item *
204
205 L<$* is no longer supported, and will become a syntax error|perldiag/"$* is no longer supported, and will become a syntax error">
206
207 The warning that use of C<$*> and C<$#> is no longer supported is now
208 generated for every location that references them.  Previously it would fail
209 to be generated if another variable using the same typeglob was seen first
210 (e.g. C<@*> before C<$*>), and would not be generated for the second and
211 subsequent uses.  (It's hard to fix the failure to generate warnings at all
212 without also generating them every time, and warning every time is
213 consistent with the warnings that C<$[> used to generate.)
214
215 =back
216
217 =head1 Utility Changes
218
219 XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here.
220 Most of these are built within the directories F<utils> and F<x2p>.
221
222 [ List utility changes as a =head3 entry for each utility and =item
223 entries for each change
224 Use L<XXX> with program names to get proper documentation linking. ]
225
226 =head3 L<XXX>
227
228 =over 4
229
230 =item *
231
232 XXX
233
234 =back
235
236 =head1 Configuration and Compilation
237
238 XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
239 go here.  Any other changes to the Perl build process should be listed here.
240 However, any platform-specific changes should be listed in the
241 L</Platform Support> section, instead.
242
243 [ List changes as a =item entry ].
244
245 =over 4
246
247 =item *
248
249 XXX
250
251 =back
252
253 =head1 Testing
254
255 XXX Any significant changes to the testing of a freshly built perl should be
256 listed here.  Changes which create B<new> files in F<t/> go here as do any
257 large changes to the testing harness (e.g. when parallel testing was added).
258 Changes to existing files in F<t/> aren't worth summarizing, although the bugs
259 that they represent may be covered elsewhere.
260
261 [ List each test improvement as a =item entry ]
262
263 =over 4
264
265 =item *
266
267 XXX
268
269 =back
270
271 =head1 Platform Support
272
273 XXX Any changes to platform support should be listed in the sections below.
274
275 [ Within the sections, list each platform as a =item entry with specific
276 changes as paragraphs below it. ]
277
278 =head2 New Platforms
279
280 XXX List any platforms that this version of perl compiles on, that previous
281 versions did not.  These will either be enabled by new files in the F<hints/>
282 directories, or new subdirectories and F<README> files at the top level of the
283 source tree.
284
285 =over 4
286
287 =item XXX-some-platform
288
289 XXX
290
291 =back
292
293 =head2 Discontinued Platforms
294
295 XXX List any platforms that this version of perl no longer compiles on.
296
297 =over 4
298
299 =item XXX-some-platform
300
301 XXX
302
303 =back
304
305 =head2 Platform-Specific Notes
306
307 XXX List any changes for specific platforms.  This could include configuration
308 and compilation changes or changes in portability/compatibility.  However,
309 changes within modules for platforms should generally be listed in the
310 L</Modules and Pragmata> section.
311
312 =over 4
313
314 =item XXX-some-platform
315
316 XXX
317
318 =back
319
320 =head1 Internal Changes
321
322 XXX Changes which affect the interface available to C<XS> code go here.  Other
323 significant internal changes for future core maintainers should be noted as
324 well.
325
326 [ List each change as a =item entry ]
327
328 =over 4
329
330 =item *
331
332 The new copy-on-write mechanism that was introduced in 5.17.7 has now been
333 disabled by default, since it was felt that there were too many rough
334 edges for the 5.18 release. It is expected that it will be enabled by
335 default for 5.20.
336
337 This change also re-enables PL_sawampersand by default.
338
339 It can be enabled in a perl build by running F<Configure> with
340 B<-Accflags=-DPERL_NEW_COPY_ON_WRITE>, and we would encourage XS authors to
341 try their code with such an enabled perl, and provide feedback.
342 XXX need blurb, e.g. a reference to a new section in perlguts or perlxs
343 explaining how XS authors should handle COW strings.
344
345
346 =back
347
348 =head1 Selected Bug Fixes
349
350 XXX Important bug fixes in the core language are summarized here.  Bug fixes in
351 files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>.
352
353 [ List each fix as a =item entry ]
354
355 =over 4
356
357 =item *
358
359 Fix two crashes in the debugger when using Frame=2 or autotrace.  These are
360 [perl #116769] and [perl #116771].
361
362 =back
363
364 =head1 Known Problems
365
366 XXX Descriptions of platform agnostic bugs we know we can't fix go here.  Any
367 tests that had to be C<TODO>ed for the release would be noted here.  Unfixed
368 platform specific bugs also go here.
369
370 [ List each fix as a =item entry ]
371
372 =over 4
373
374 =item *
375
376 XXX
377
378 =back
379
380 =head1 Obituary
381
382 XXX If any significant core contributor has died, we've added a short obituary
383 here.
384
385 =head1 Acknowledgements
386
387 XXX Generate this with:
388
389   perl Porting/acknowledgements.pl v5.17.9..HEAD
390
391 =head1 Reporting Bugs
392
393 If you find what you think is a bug, you might check the articles recently
394 posted to the comp.lang.perl.misc newsgroup and the perl bug database at
395 http://rt.perl.org/perlbug/ .  There may also be information at
396 http://www.perl.org/ , the Perl Home Page.
397
398 If you believe you have an unreported bug, please run the L<perlbug> program
399 included with your release.  Be sure to trim your bug down to a tiny but
400 sufficient test case.  Your bug report, along with the output of C<perl -V>,
401 will be sent off to perlbug@perl.org to be analysed by the Perl porting team.
402
403 If the bug you are reporting has security implications, which make it
404 inappropriate to send to a publicly archived mailing list, then please send it
405 to perl5-security-report@perl.org.  This points to a closed subscription
406 unarchived mailing list, which includes all the core committers, who will be
407 able to help assess the impact of issues, figure out a resolution, and help
408 co-ordinate the release of patches to mitigate or fix the problem across all
409 platforms on which Perl is supported.  Please only use this address for
410 security issues in the Perl core, not for modules independently distributed on
411 CPAN.
412
413 =head1 SEE ALSO
414
415 The F<Changes> file for an explanation of how to view exhaustive details on
416 what changed.
417
418 The F<INSTALL> file for how to build Perl.
419
420 The F<README> file for general stuff.
421
422 The F<Artistic> and F<Copying> files for copyright information.
423
424 =cut