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