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