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