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