[perl5.git] / Porting / perl5180delta.pod

=encoding utf8

=head1 NAME

[ this is a template for a new perldelta file.  Any text flagged as XXX needs
to be processed before release. ]

perl5180delta - what is new for perl v5.tXXX.cXXX

=head1 DESCRIPTION

This document describes differences between the 5.sXXX.bXXX release and the 5.tXXX.cXXX
release.

If you are upgrading from an earlier release such as 5.rXXX.aXXX, first read
L<perl5XXXdelta>, which describes differences between 5.rXXX.aXXX and 5.sXXX.bXXX.

=head1 Notice

XXX Any important notices here

=head1 Core Enhancements

XXX New core language features go here.  Summarize user-visible core language
enhancements.  Particularly prominent performance optimisations could go
here, but most should go in the L</Performance Enhancements> section.

[ List each enhancement as a =head2 entry ]

=head1 Security

XXX Any security-related notices go here.  In particular, any security
vulnerabilities closed should be noted here rather than in the
L</Selected Bug Fixes> section.

[ List each security issue as a =head2 entry ]

=head1 Incompatible Changes

XXX For a release on a stable branch, this section aspires to be:

    There are no changes intentionally incompatible with 5.XXX.XXX
    If any exist, they are bugs, and we request that you submit a
    report.  See L</Reporting Bugs> below.

[ List each incompatible change as a =head2 entry ]

=head1 Deprecations

XXX Any deprecated features, syntax, modules etc. should be listed here.  In
particular, deprecated modules should be listed here even if they are listed as
an updated module in the L</Modules and Pragmata> section.

[ List each deprecation as a =head2 entry ]

=head1 Performance Enhancements

XXX Changes which enhance performance without changing behaviour go here.
There may well be none in a stable release.

[ List each enhancement as a =item entry ]

=over 4

=item *

XXX

=back

=head1 Modules and Pragmata

XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
go here.  If Module::CoreList is updated, generate an initial draft of the
following sections using F<Porting/corelist-perldelta.pl>, which prints stub
entries to STDOUT.  Results can be pasted in place of the '=head2' entries
below.  A paragraph summary for important changes should then be added by hand.
In an ideal world, dual-life modules would have a F<Changes> file that could be
cribbed.

[ Within each section, list entries as a =item entry ]

=head2 New Modules and Pragmata

=over 4

=item *

XXX

=back

=head2 Updated Modules and Pragmata

=over 4

=item *

L<XXX> has been upgraded from version A.xx to B.yy.

=back

=head2 Removed Modules and Pragmata

=over 4

=item *

XXX

=back

=head1 Documentation

XXX Changes to files in F<pod/> go here.  Consider grouping entries by
file and be sure to link to the appropriate page, e.g. L<perlfunc>.

=head2 New Documentation

XXX Changes which create B<new> files in F<pod/> go here.

=head3 L<XXX>

XXX Description of the purpose of the new file here

=head2 Changes to Existing Documentation

XXX Changes which significantly change existing files in F<pod/> go here.
However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
section.

=head3 L<XXX>

=over 4

=item *

XXX Description of the change here

=back

=head1 Diagnostics

The following additions or changes have been made to diagnostic output,
including warnings and fatal error messages.  For the complete list of
diagnostic messages, see L<perldiag>.

XXX New or changed warnings emitted by the core's C<C> code go here.  Also
include any changes in L<perldiag> that reconcile it to the C<C> code.

=head2 New Diagnostics

XXX Newly added diagnostic messages go under here, separated into New Errors
and New Warnings

=head3 New Errors

=over 4

=item *

XXX L<message|perldiag/"message">

=back

=head3 New Warnings

=over 4

=item *

XXX L<message|perldiag/"message">

=back

=head2 Changes to Existing Diagnostics

XXX Changes (i.e. rewording) of diagnostic messages go here

=over 4

=item *

XXX Describe change here

=back

=head1 Utility Changes

XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here.
Most of these are built within the directories F<utils> and F<x2p>.

[ List utility changes as a =head3 entry for each utility and =item
entries for each change
Use L<XXX> with program names to get proper documentation linking. ]

=head3 L<XXX>

=over 4

=item *

XXX

=back

=head1 Configuration and Compilation

XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
go here.  Any other changes to the Perl build process should be listed here.
However, any platform-specific changes should be listed in the
L</Platform Support> section, instead.

[ List changes as a =item entry ].

=over 4

=item *

XXX

=back

=head1 Testing

XXX Any significant changes to the testing of a freshly built perl should be
listed here.  Changes which create B<new> files in F<t/> go here as do any
large changes to the testing harness (e.g. when parallel testing was added).
Changes to existing files in F<t/> aren't worth summarizing, although the bugs
that they represent may be covered elsewhere.

[ List each test improvement as a =item entry ]

=over 4

=item *

XXX

=back

=head1 Platform Support

XXX Any changes to platform support should be listed in the sections below.

[ Within the sections, list each platform as a =item entry with specific
changes as paragraphs below it. ]

=head2 New Platforms

XXX List any platforms that this version of perl compiles on, that previous
versions did not.  These will either be enabled by new files in the F<hints/>
directories, or new subdirectories and F<README> files at the top level of the
source tree.

=over 4

=item XXX-some-platform

XXX

=back

=head2 Discontinued Platforms

XXX List any platforms that this version of perl no longer compiles on.

=over 4

=item XXX-some-platform

XXX

=back

=head2 Platform-Specific Notes

XXX List any changes for specific platforms.  This could include configuration
and compilation changes or changes in portability/compatibility.  However,
changes within modules for platforms should generally be listed in the
L</Modules and Pragmata> section.

=over 4

=item XXX-some-platform

XXX

=back

=head1 Internal Changes

XXX Changes which affect the interface available to C<XS> code go here.  Other
significant internal changes for future core maintainers should be noted as
well.

[ List each change as a =item entry ]

=over 4

=item *

XXX

=back

=head1 Selected Bug Fixes

XXX Important bug fixes in the core language are summarized here.  Bug fixes in
files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>.

[ List each fix as a =item entry ]

=over 4

=item *

XXX

=back

=head1 Known Problems

XXX Descriptions of platform agnostic bugs we know we can't fix go here.  Any
tests that had to be C<TODO>ed for the release would be noted here.  Unfixed
platform specific bugs also go here.

[ List each fix as a =item entry ]

=over 4

=item *

=item *

The following CPAN modules have test failures with perl 5.18.  Patches have
been submitted for all of these, so hopefully there will be new releases
soon:

=over

=item *

L<B::Hooks::Parser> version 0.11

=item *

L<Coro> version 6.10

=item *

L<Crypt::IDEA> version 1.08

=item *

L<Crypt::Twofish> version 2.15

=item *

L<Data::Dump::Streamer> version 2.34

=item *

L<Devel::LexAlias> version 0.04

=item *

L<Lexical::Var> version 0.007

=back

=back

=head1 Obituary

XXX If any significant core contributor has died, we've added a short obituary
here.

=head1 Acknowledgements

XXX Generate this with:

  perl Porting/acknowledgements.pl v5.17.7..HEAD

=head1 Reporting Bugs

If you find what you think is a bug, you might check the articles recently
posted to the comp.lang.perl.misc newsgroup and the perl bug database at
http://rt.perl.org/perlbug/ .  There may also be information at
http://www.perl.org/ , the Perl Home Page.

If you believe you have an unreported bug, please run the L<perlbug> program
included with your release.  Be sure to trim your bug down to a tiny but
sufficient test case.  Your bug report, along with the output of C<perl -V>,
will be sent off to perlbug@perl.org to be analysed by the Perl porting team.

If the bug you are reporting has security implications, which make it
inappropriate to send to a publicly archived mailing list, then please send it
to perl5-security-report@perl.org.  This points to a closed subscription
unarchived mailing list, which includes all the core committers, who will be
able to help assess the impact of issues, figure out a resolution, and help
co-ordinate the release of patches to mitigate or fix the problem across all
platforms on which Perl is supported.  Please only use this address for
security issues in the Perl core, not for modules independently distributed on
CPAN.

=head1 SEE ALSO

The F<Changes> file for an explanation of how to view exhaustive details on
what changed.

The F<INSTALL> file for how to build Perl.

The F<README> file for general stuff.

The F<Artistic> and F<Copying> files for copyright information.

=cut
Commit	Line	Data
e5ba1bf1 FC	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	perl5180delta - what is new for perl v5.tXXX.cXXX
	9
	10	=head1 DESCRIPTION
	11
	12	This document describes differences between the 5.sXXX.bXXX release and the 5.tXXX.cXXX
	13	release.
	14
	15	If you are upgrading from an earlier release such as 5.rXXX.aXXX, first read
	16	L<perl5XXXdelta>, which describes differences between 5.rXXX.aXXX and 5.sXXX.bXXX.
	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	XXX L<message\|perldiag/"message">
173
174	=back
175
176	=head2 Changes to Existing Diagnostics
177
178	XXX Changes (i.e. rewording) of diagnostic messages go here
179
180	=over 4
181
182	=item *
183
184	XXX Describe change here
185
186	=back
187
188	=head1 Utility Changes
189
190	XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here.
191	Most of these are built within the directories F<utils> and F<x2p>.
192
193	[ List utility changes as a =head3 entry for each utility and =item
194	entries for each change
195	Use L<XXX> with program names to get proper documentation linking. ]
196
197	=head3 L<XXX>
198
199	=over 4
200
201	=item *
202
203	XXX
204
205	=back
206
207	=head1 Configuration and Compilation
208
209	XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
210	go here. Any other changes to the Perl build process should be listed here.
211	However, any platform-specific changes should be listed in the
212	L</Platform Support> section, instead.
213
214	[ List changes as a =item entry ].
215
216	=over 4
217
218	=item *
219
220	XXX
221
222	=back
223
224	=head1 Testing
225
226	XXX Any significant changes to the testing of a freshly built perl should be
227	listed here. Changes which create B<new> files in F<t/> go here as do any
228	large changes to the testing harness (e.g. when parallel testing was added).
229	Changes to existing files in F<t/> aren't worth summarizing, although the bugs
230	that they represent may be covered elsewhere.
231
232	[ List each test improvement as a =item entry ]
233
234	=over 4
235
236	=item *
237
238	XXX
239
240	=back
241
242	=head1 Platform Support
243
244	XXX Any changes to platform support should be listed in the sections below.
245
246	[ Within the sections, list each platform as a =item entry with specific
247	changes as paragraphs below it. ]
248
249	=head2 New Platforms
250
251	XXX List any platforms that this version of perl compiles on, that previous
252	versions did not. These will either be enabled by new files in the F<hints/>
253	directories, or new subdirectories and F<README> files at the top level of the
254	source tree.
255
256	=over 4
257
258	=item XXX-some-platform
259
260	XXX
261
262	=back
263
264	=head2 Discontinued Platforms
265
266	XXX List any platforms that this version of perl no longer compiles on.
267
268	=over 4
269
270	=item XXX-some-platform
271
272	XXX
273
274	=back
275
276	=head2 Platform-Specific Notes
277
278	XXX List any changes for specific platforms. This could include configuration
279	and compilation changes or changes in portability/compatibility. However,
280	changes within modules for platforms should generally be listed in the
281	L</Modules and Pragmata> section.
282
283	=over 4
284
285	=item XXX-some-platform
286
287	XXX
288
289	=back
290
291	=head1 Internal Changes
292
293	XXX Changes which affect the interface available to C<XS> code go here. Other
294	significant internal changes for future core maintainers should be noted as
295	well.
296
297	[ List each change as a =item entry ]
298
299	=over 4
300
301	=item *
302
303	XXX
304
305	=back
306
307	=head1 Selected Bug Fixes
308
309	XXX Important bug fixes in the core language are summarized here. Bug fixes in
310	files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>.
311
312	[ List each fix as a =item entry ]
313
314	=over 4
315
316	=item *
317
318	XXX
319
320	=back
321
322	=head1 Known Problems
323
324	XXX Descriptions of platform agnostic bugs we know we can't fix go here. Any
325	tests that had to be C<TODO>ed for the release would be noted here. Unfixed
326	platform specific bugs also go here.
327
328	[ List each fix as a =item entry ]
329
330	=over 4
331
332	=item *
333
23dd6e2e FC	334	=item *
23dd6e2e FC	335
2917e21e	336	The following CPAN modules have test failures with perl 5.18. Patches have
23dd6e2e FC	337	been submitted for all of these, so hopefully there will be new releases
	338	soon:
	339
	340	=over
	341
	342	=item *
	343
b92848b5 FC	344	L<B::Hooks::Parser> version 0.11
b92848b5 FC	345
0f023b5a FC	346	=item *
	347
	348	L<Coro> version 6.10
	349
	350	=item *
	351
c53e3a75 FC	352	L<Crypt::IDEA> version 1.08
	353
	354	=item *
	355
	356	L<Crypt::Twofish> version 2.15
	357
	358	=item *
	359
0f023b5a FC	360	L<Data::Dump::Streamer> version 2.34
	361
	362	=item *
	363
	364	L<Devel::LexAlias> version 0.04
	365
	366	=item *
	367
	368	L<Lexical::Var> version 0.007
	369
23dd6e2e	370	=back
e5ba1bf1 FC	371
	372	=back
	373
	374	=head1 Obituary
	375
	376	XXX If any significant core contributor has died, we've added a short obituary
	377	here.
	378
	379	=head1 Acknowledgements
	380
	381	XXX Generate this with:
	382
0af431d3	383	perl Porting/acknowledgements.pl v5.17.7..HEAD
e5ba1bf1 FC	384
	385	=head1 Reporting Bugs
	386
	387	If you find what you think is a bug, you might check the articles recently
	388	posted to the comp.lang.perl.misc newsgroup and the perl bug database at
	389	http://rt.perl.org/perlbug/ . There may also be information at
	390	http://www.perl.org/ , the Perl Home Page.
	391
	392	If you believe you have an unreported bug, please run the L<perlbug> program
	393	included with your release. Be sure to trim your bug down to a tiny but
	394	sufficient test case. Your bug report, along with the output of C<perl -V>,
	395	will be sent off to perlbug@perl.org to be analysed by the Perl porting team.
	396
	397	If the bug you are reporting has security implications, which make it
	398	inappropriate to send to a publicly archived mailing list, then please send it
	399	to perl5-security-report@perl.org. This points to a closed subscription
	400	unarchived mailing list, which includes all the core committers, who will be
	401	able to help assess the impact of issues, figure out a resolution, and help
	402	co-ordinate the release of patches to mitigate or fix the problem across all
	403	platforms on which Perl is supported. Please only use this address for
	404	security issues in the Perl core, not for modules independently distributed on
	405	CPAN.
	406
	407	=head1 SEE ALSO
	408
	409	The F<Changes> file for an explanation of how to view exhaustive details on
	410	what changed.
	411
	412	The F<INSTALL> file for how to build Perl.
	413
	414	The F<README> file for general stuff.
	415
	416	The F<Artistic> and F<Copying> files for copyright information.
	417
	418	=cut