This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
1aa113532b2523bc37081db955440ac99103acc1
[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 =back
119
120 =head2 Removed Modules and Pragmata
121
122 =over 4
123
124 =item *
125
126 XXX
127
128 =back
129
130 =head1 Documentation
131
132 XXX Changes to files in F<pod/> go here.  Consider grouping entries by
133 file and be sure to link to the appropriate page, e.g. L<perlfunc>.
134
135 =head2 New Documentation
136
137 XXX Changes which create B<new> files in F<pod/> go here.
138
139 =head3 L<XXX>
140
141 XXX Description of the purpose of the new file here
142
143 =head2 Changes to Existing Documentation
144
145 XXX Changes which significantly change existing files in F<pod/> go here.
146 However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
147 section.
148
149 =head3 L<perlrebackslash/\N>
150
151 =over 4
152
153 =item *
154
155 This feature is no longer experimental.
156
157 =back
158
159 =head1 Diagnostics
160
161 The following additions or changes have been made to diagnostic output,
162 including warnings and fatal error messages.  For the complete list of
163 diagnostic messages, see L<perldiag>.
164
165 XXX New or changed warnings emitted by the core's C<C> code go here.  Also
166 include any changes in L<perldiag> that reconcile it to the C<C> code.
167
168 =head2 New Diagnostics
169
170 XXX Newly added diagnostic messages go under here, separated into New Errors
171 and New Warnings
172
173 =head3 New Errors
174
175 =over 4
176
177 =item *
178
179 XXX L<message|perldiag/"message">
180
181 =back
182
183 =head3 New Warnings
184
185 =over 4
186
187 =item *
188
189 XXX L<message|perldiag/"message">
190
191 =back
192
193 =head2 Changes to Existing Diagnostics
194
195 XXX Changes (i.e. rewording) of diagnostic messages go here
196
197 =over 4
198
199 =item *
200
201 XXX Describe change here
202
203 =back
204
205 =head1 Utility Changes
206
207 XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here.
208 Most of these are built within the directories F<utils> and F<x2p>.
209
210 [ List utility changes as a =head3 entry for each utility and =item
211 entries for each change
212 Use L<XXX> with program names to get proper documentation linking. ]
213
214 =head3 L<XXX>
215
216 =over 4
217
218 =item *
219
220 XXX
221
222 =back
223
224 =head1 Configuration and Compilation
225
226 XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
227 go here.  Any other changes to the Perl build process should be listed here.
228 However, any platform-specific changes should be listed in the
229 L</Platform Support> section, instead.
230
231 [ List changes as a =item entry ].
232
233 =over 4
234
235 =item *
236
237 XXX
238
239 =back
240
241 =head1 Testing
242
243 XXX Any significant changes to the testing of a freshly built perl should be
244 listed here.  Changes which create B<new> files in F<t/> go here as do any
245 large changes to the testing harness (e.g. when parallel testing was added).
246 Changes to existing files in F<t/> aren't worth summarizing, although the bugs
247 that they represent may be covered elsewhere.
248
249 [ List each test improvement as a =item entry ]
250
251 =over 4
252
253 =item *
254
255 XXX
256
257 =back
258
259 =head1 Platform Support
260
261 XXX Any changes to platform support should be listed in the sections below.
262
263 [ Within the sections, list each platform as a =item entry with specific
264 changes as paragraphs below it. ]
265
266 =head2 New Platforms
267
268 XXX List any platforms that this version of perl compiles on, that previous
269 versions did not.  These will either be enabled by new files in the F<hints/>
270 directories, or new subdirectories and F<README> files at the top level of the
271 source tree.
272
273 =over 4
274
275 =item XXX-some-platform
276
277 XXX
278
279 =back
280
281 =head2 Discontinued Platforms
282
283 XXX List any platforms that this version of perl no longer compiles on.
284
285 =over 4
286
287 =item XXX-some-platform
288
289 XXX
290
291 =back
292
293 =head2 Platform-Specific Notes
294
295 XXX List any changes for specific platforms.  This could include configuration
296 and compilation changes or changes in portability/compatibility.  However,
297 changes within modules for platforms should generally be listed in the
298 L</Modules and Pragmata> section.
299
300 =over 4
301
302 =item XXX-some-platform
303
304 XXX
305
306 =back
307
308 =head1 Internal Changes
309
310 XXX Changes which affect the interface available to C<XS> code go here.  Other
311 significant internal changes for future core maintainers should be noted as
312 well.
313
314 [ List each change as a =item entry ]
315
316 =over 4
317
318 =item *
319
320 The new copy-on-write mechanism that was introduced in 5.17.7 has now been
321 disabled by default, since it was felt that there were too many rough
322 edges for the 5.18 release. It is expected that it will be enabled by
323 default for 5.20.
324
325 This change also re-enables PL_sawampersand by default.
326
327 It can be enabled in a perl build by running F<Configure> with
328 B<-Accflags=-DPERL_NEW_COPY_ON_WRITE>, and we would encourage XS authors to
329 try their code with such an enabled perl, and provide feedback.
330 XXX need blurb, e.g. a reference to a new section in perlguts or perlxs
331 explaining how XS authors should handle COW strings.
332
333
334 =back
335
336 =head1 Selected Bug Fixes
337
338 XXX Important bug fixes in the core language are summarized here.  Bug fixes in
339 files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>.
340
341 [ List each fix as a =item entry ]
342
343 =over 4
344
345 =item *
346
347 Fix two crashes in the debugger when using Frame=2 or autotrace.  These are
348 [perl #116769] and [perl #116771].
349
350 =back
351
352 =head1 Known Problems
353
354 XXX Descriptions of platform agnostic bugs we know we can't fix go here.  Any
355 tests that had to be C<TODO>ed for the release would be noted here.  Unfixed
356 platform specific bugs also go here.
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.17.9..HEAD
378
379 =head1 Reporting Bugs
380
381 If you find what you think is a bug, you might check the articles recently
382 posted to the comp.lang.perl.misc newsgroup and the perl bug database at
383 http://rt.perl.org/perlbug/ .  There may also be information at
384 http://www.perl.org/ , the Perl Home Page.
385
386 If you believe you have an unreported bug, please run the L<perlbug> program
387 included with your release.  Be sure to trim your bug down to a tiny but
388 sufficient test case.  Your bug report, along with the output of C<perl -V>,
389 will be sent off to perlbug@perl.org to be 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 it
393 to perl5-security-report@perl.org.  This points to a closed subscription
394 unarchived mailing list, which includes all the core committers, who will be
395 able to help assess the impact of issues, figure out a resolution, and help
396 co-ordinate the release of patches to mitigate or fix the problem across all
397 platforms on which Perl is supported.  Please only use this address for
398 security issues in the Perl core, not for modules independently distributed on
399 CPAN.
400
401 =head1 SEE ALSO
402
403 The F<Changes> file for an explanation of how to view exhaustive details on
404 what changed.
405
406 The F<INSTALL> file for how to build Perl.
407
408 The F<README> file for general stuff.
409
410 The F<Artistic> and F<Copying> files for copyright information.
411
412 =cut