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