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