This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Fix multiple perldelta entries from buildtoc on VMS.
[perl5.git] / pod / perldelta.pod
CommitLineData
3a5c9134
CBW
1=encoding utf8
2
3=head1 NAME
4
5[ this is a template for a new perldelta file. Any text flagged as
6XXX needs to be processed before release. ]
7
8perldelta - what is new for perl v5.13.8
9
10=head1 DESCRIPTION
11
12This document describes differences between the 5.13.8 release and
13the 5.13.7 release.
14
dbbe2d83 15If you are upgrading from an earlier release such as 5.13.6, first read
3a5c9134
CBW
16L<perl5137delta>, which describes differences between 5.13.6 and
175.13.7.
18
19=head1 Notice
20
21XXX Any important notices here
22
23=head1 Core Enhancements
24
25XXX New core language features go here. Summarise user-visible core language
26enhancements. Particularly prominent performance optimisations could go
27here, but most should go in the L</Performance Enhancements> section.
28
29[ List each enhancement as a =head2 entry ]
30
31=head1 Security
32
33XXX Any security-related notices go here. In particular, any security
34vulnerabilities closed should be noted here rather than in the
35L</Selected Bug Fixes> section.
36
37[ List each security issue as a =head2 entry ]
38
39=head1 Incompatible Changes
40
41XXX For a release on a stable branch, this section aspires to be:
42
43 There are no changes intentionally incompatible with 5.XXX.XXX. If any
44 exist, they are bugs and reports are welcome.
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.
51In particular, deprecated modules should be listed here even if they are
52listed as 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
58XXX Changes which enhance performance without changing behaviour go here. There
59may 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
99XXX
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[ Within each section, list entries as a =item entry ]
152
153=head2 New Diagnostics
154
155XXX Newly added diagnostic messages go here
156
157=over 4
158
159=item *
160
161XXX
162
163=back
164
165=head2 Changes to Existing Diagnostics
166
167XXX Changes (i.e. rewording) of diagnostic messages go here
168
169=over 4
170
171=item *
172
173XXX
174
175=back
176
177=head1 Utility Changes
178
179XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go
180here. Most of these are built within the directories F<utils> and F<x2p>.
181
182[ List utility changes as a =head3 entry for each utility and =item
183entries for each change
184Use L<XXX> with program names to get proper documentation linking. ]
185
186=head3 L<XXX>
187
188=over 4
189
190=item *
191
192XXX
193
194=back
195
196=head1 Configuration and Compilation
197
198XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
199go here. Any other changes to the Perl build process should be listed here.
200However, any platform-specific changes should be listed in the
201L</Platform Support> section, instead.
202
203[ List changes as a =item entry ].
204
205=over 4
206
207=item *
208
209XXX
210
211=back
212
213=head1 Testing
214
215XXX Any significant changes to the testing of a freshly built perl should be
216listed here. Changes which create B<new> files in F<t/> go here as do any
217large changes to the testing harness (e.g. when parallel testing was added).
218Changes to existing files in F<t/> aren't worth summarising, although the bugs
219that they represent may be covered elsewhere.
220
221[ List each test improvement as a =item entry ]
222
223=over 4
224
225=item *
226
227XXX
228
229=back
230
231=head1 Platform Support
232
233XXX Any changes to platform support should be listed in the sections below.
234
235[ Within the sections, list each platform as a =item entry with specific
236changes as paragraphs below it. ]
237
238=head2 New Platforms
239
240XXX List any platforms that this version of perl compiles on, that previous
241versions did not. These will either be enabled by new files in the F<hints/>
242directories, or new subdirectories and F<README> files at the top level of the
243source tree.
244
245=over 4
246
247=item XXX-some-platform
248
249XXX
250
251=back
252
253=head2 Discontinued Platforms
254
255XXX List any platforms that this version of perl no longer compiles on.
256
257=over 4
258
259=item XXX-some-platform
260
261XXX
262
263=back
264
265=head2 Platform-Specific Notes
266
267XXX List any changes for specific platforms. This could include configuration
268and compilation changes or changes in portability/compatibility. However,
269changes within modules for platforms should generally be listed in the
270L</Modules and Pragmata> section.
271
272=over 4
273
274=item XXX-some-platform
275
276XXX
277
278=back
279
280=head1 Internal Changes
281
282XXX Changes which affect the interface available to C<XS> code go here.
283Other significant internal changes for future core maintainers should
284be noted as well.
285
286[ List each test improvement as a =item entry ]
287
288=over 4
289
290=item *
291
292XXX
293
294=back
295
296=head1 Selected Bug Fixes
297
298XXX Important bug fixes in the core language are summarised here.
299Bug fixes in files in F<ext/> and F<lib/> are best summarised in
300L</Modules and Pragmata>.
301
302[ List each fix as a =item entry ]
303
304=over 4
305
306=item *
307
308XXX
309
310=back
311
312=head1 Known Problems
313
314XXX Descriptions of platform agnostic bugs we know we can't fix go here. Any
315tests that had to be C<TODO>ed for the release would be noted here, unless
316they were specific to a particular platform (see below).
317
318This is a list of some significant unfixed bugs, which are regressions
319from either 5.XXX.XXX or 5.XXX.XXX.
320
321[ List each fix as a =item entry ]
322
323=over 4
324
325=item *
326
2283d326
KW
327A number of bugs with regular expression bracketed character classes
328have been fixed, mostly having to do with matching characters in the
329non-ASCII Latin-1 range.
3a5c9134
CBW
330
331=back
332
333=head1 Obituary
334
335XXX If any significant core contributor has died, we've added a short obituary
336here.
337
338=head1 Acknowledgements
339
340XXX The list of people to thank goes here.
341
342=head1 Reporting Bugs
343
344If you find what you think is a bug, you might check the articles
345recently posted to the comp.lang.perl.misc newsgroup and the perl
346bug database at http://rt.perl.org/perlbug/ . There may also be
347information at http://www.perl.org/ , the Perl Home Page.
348
349If you believe you have an unreported bug, please run the L<perlbug>
350program included with your release. Be sure to trim your bug down
351to a tiny but sufficient test case. Your bug report, along with the
352output of C<perl -V>, will be sent off to perlbug@perl.org to be
353analysed by the Perl porting team.
354
355If the bug you are reporting has security implications, which make it
356inappropriate to send to a publicly archived mailing list, then please send
357it to perl5-security-report@perl.org. This points to a closed subscription
358unarchived mailing list, which includes all the core committers, who be able
359to help assess the impact of issues, figure out a resolution, and help
360co-ordinate the release of patches to mitigate or fix the problem across all
361platforms on which Perl is supported. Please only use this address for
362security issues in the Perl core, not for modules independently
363distributed on CPAN.
364
365=head1 SEE ALSO
366
367The F<Changes> file for an explanation of how to view exhaustive details
368on what changed.
369
370The F<INSTALL> file for how to build Perl.
371
372The F<README> file for general stuff.
373
374The F<Artistic> and F<Copying> files for copyright information.
375
376=cut