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