This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Fix the test count in t/re/pat.t
[perl5.git] / pod / perldelta.pod
CommitLineData
4c793fe3
FR
1=encoding utf8
2
3=head1 NAME
4
8f97a47a
TM
5[ this is a template for a new perldelta file. Any text flagged as
6XXX needs to be processed before release. ]
4c793fe3 7
8f97a47a 8perldelta - what is new for perl v5.13.7
a12cf05f 9
8f97a47a 10=head1 DESCRIPTION
fb121860 11
8f97a47a
TM
12This document describes differences between the 5.13.6 release and
13the 5.13.7 release.
eb32ee41 14
8f97a47a
TM
15If you are upgrading from an earlier release such as 5.13.5, first read
16L<perl5136delta>, which describes differences between 5.13.5 and
175.13.6.
eb32ee41 18
8f97a47a 19=head1 Notice
eb32ee41 20
8f97a47a 21XXX Any important notices here
5e26bbbe 22
8f97a47a 23=head1 Core Enhancements
5e26bbbe 24
8f97a47a
TM
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.
5e26bbbe 28
8f97a47a 29[ List each enhancement as a =head2 entry ]
4f65bc30 30
8f97a47a 31=head1 Security
4f65bc30 32
8f97a47a
TM
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.
0eec0a4c 36
8f97a47a 37[ List each security issue as a =head2 entry ]
0eec0a4c 38
4c793fe3
FR
39=head1 Incompatible Changes
40
8f97a47a 41XXX For a release on a stable branch, this section aspires to be:
9de15fec 42
8f97a47a
TM
43 There are no changes intentionally incompatible with 5.XXX.XXX. If any
44 exist, they are bugs and reports are welcome.
9de15fec 45
8f97a47a 46[ List each incompatible change as a =head2 entry ]
9de15fec 47
8f97a47a 48=head1 Deprecations
6904a83f 49
8f97a47a
TM
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.
6904a83f 53
8f97a47a 54[ List each deprecation as a =head2 entry ]
afa74577 55
4c793fe3
FR
56=head1 Performance Enhancements
57
8f97a47a
TM
58XXX Changes which enhance performance without changing behaviour go here. There
59may well be none in a stable release.
4c793fe3 60
8f97a47a 61[ List each enhancement as a =item entry ]
e2babdfb 62
8f97a47a 63=over 4
e2babdfb 64
b141c43c
FR
65=item *
66
8f97a47a 67XXX
b141c43c 68
4c793fe3
FR
69=back
70
71=head1 Modules and Pragmata
72
8f97a47a
TM
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.
e2941eb0 80
8f97a47a 81[ Within each section, list entries as a =item entry ]
e2941eb0 82
8f97a47a 83=head2 New Modules and Pragmata
25e68b8b 84
8f97a47a 85=over 4
463da0ac
CBW
86
87=item *
88
8f97a47a 89XXX
6481ebaf 90
8f97a47a 91=back
6481ebaf 92
8f97a47a 93=head2 Updated Modules and Pragmata
6481ebaf 94
8f97a47a 95=over 4
ac4c9720
CBW
96
97=item *
98
8f97a47a 99XXX
dfa4c013 100
8f97a47a 101=back
dfa4c013 102
8f97a47a 103=head2 Removed Modules and Pragmata
c02ee425 104
8f97a47a 105=over 4
1393fe00
CBW
106
107=item *
108
8f97a47a 109XXX
c9a84c8b 110
8f97a47a 111=back
918184d1 112
8f97a47a 113=head1 Documentation
918184d1 114
8f97a47a
TM
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>.
918184d1 117
8f97a47a 118=head2 New Documentation
dca41e57 119
8f97a47a 120XXX Changes which create B<new> files in F<pod/> go here.
dca41e57 121
8f97a47a 122=head3 L<XXX>
c9a84c8b 123
8f97a47a 124XXX Description of the purpose of the new file here
4c793fe3 125
ee0887a9 126=head2 Changes to Existing Documentation
fc1418b7 127
8f97a47a
TM
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>
e2babdfb 133
7bc3efda
SH
134=over 4
135
136=item *
137
8f97a47a 138XXX Description of the change here
7bc3efda
SH
139
140=back
e2babdfb 141
4c793fe3
FR
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
8f97a47a
TM
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.
4c793fe3 150
8f97a47a 151[ Within each section, list entries as a =item entry ]
4c793fe3 152
8f97a47a 153=head2 New Diagnostics
4c793fe3 154
8f97a47a 155XXX Newly added diagnostic messages go here
dc08898c
FC
156
157=over 4
158
159=item *
160
8f97a47a 161XXX
dc08898c
FC
162
163=back
164
8f97a47a 165=head2 Changes to Existing Diagnostics
4c793fe3 166
8f97a47a 167XXX Changes (i.e. rewording) of diagnostic messages go here
0c692eed 168
ee0887a9 169=over 4
0c692eed
FR
170
171=item *
172
8f97a47a 173XXX
4c793fe3
FR
174
175=back
176
8f97a47a 177=head1 Utility Changes
810f3b7c 178
8f97a47a
TM
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>.
a9e68e41 181
8f97a47a
TM
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. ]
a9e68e41 185
8f97a47a 186=head3 L<XXX>
85318b69 187
ee0887a9 188=over 4
80b6a949 189
e2babdfb
FR
190=item *
191
8f97a47a 192XXX
9ae8c3d9 193
ee0887a9 194=back
e2babdfb 195
8f97a47a 196=head1 Configuration and Compilation
e2babdfb 197
8f97a47a
TM
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.
346e4e56 202
8f97a47a 203[ List changes as a =item entry ].
78846812 204
8f97a47a 205=over 4
e54f3f30
FC
206
207=item *
208
8f97a47a 209XXX
e54f3f30 210
8f97a47a 211=back
a5763045 212
8f97a47a 213=head1 Testing
5a9a79a4 214
8f97a47a
TM
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.
5a9a79a4 220
8f97a47a 221[ List each test improvement as a =item entry ]
a7e93501 222
8f97a47a 223=over 4
a7e93501
FC
224
225=item *
226
8f97a47a 227XXX
a7e93501 228
8f97a47a 229=back
a7e93501 230
8f97a47a 231=head1 Platform Support
a7e93501 232
8f97a47a 233XXX Any changes to platform support should be listed in the sections below.
a7e93501 234
8f97a47a
TM
235[ Within the sections, list each platform as a =item entry with specific
236changes as paragraphs below it. ]
a7e93501 237
8f97a47a 238=head2 New Platforms
d4a59e54 239
8f97a47a
TM
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.
d4a59e54 244
8f97a47a 245=over 4
dc08898c 246
8f97a47a 247=item XXX-some-platform
dc08898c 248
8f97a47a 249XXX
dc08898c 250
8f97a47a 251=back
6904a83f 252
8f97a47a 253=head2 Discontinued Platforms
6904a83f 254
8f97a47a 255XXX List any platforms that this version of perl no longer compiles on.
6904a83f 256
8f97a47a 257=over 4
cffb3698 258
8f97a47a 259=item XXX-some-platform
ab4c2c27 260
8f97a47a 261XXX
ab4c2c27 262
8f97a47a 263=back
be1cc451 264
8f97a47a 265=head2 Platform-Specific Notes
be1cc451 266
8f97a47a
TM
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.
b20c4ee1 271
8f97a47a 272=over 4
b20c4ee1 273
8f97a47a 274=item XXX-some-platform
afa74577 275
8f97a47a 276XXX
afa74577 277
8f97a47a 278=back
c8bbf675 279
8f97a47a 280=head1 Internal Changes
c8bbf675 281
8f97a47a
TM
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.
07d5f7aa 285
8f97a47a 286[ List each test improvement as a =item entry ]
07d5f7aa 287
8f97a47a 288=over 4
07d5f7aa 289
9ae8c3d9
FC
290=item *
291
8f97a47a 292XXX
9ae8c3d9 293
8f97a47a 294=back
825563b9 295
8f97a47a 296=head1 Selected Bug Fixes
825563b9 297
8f97a47a
TM
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>.
825563b9 301
8f97a47a 302[ List each fix as a =item entry ]
825563b9 303
8f97a47a 304=over 4
825563b9 305
020fe755
AB
306=item *
307
8f97a47a 308XXX
020fe755 309
8f97a47a 310=back
020fe755 311
8f97a47a 312=head1 Known Problems
020fe755 313
8f97a47a
TM
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).
62ff64ce 317
8f97a47a
TM
318This is a list of some significant unfixed bugs, which are regressions
319from either 5.XXX.XXX or 5.XXX.XXX.
62ff64ce 320
8f97a47a 321[ List each fix as a =item entry ]
62ff64ce 322
8f97a47a 323=over 4
62ff64ce
FC
324
325=item *
326
8f97a47a 327XXX
62ff64ce 328
4c793fe3
FR
329=back
330
8f97a47a 331=head1 Obituary
405fd67e 332
8f97a47a
TM
333XXX If any significant core contributor has died, we've added a short obituary
334here.
405fd67e 335
ee0887a9 336=head1 Acknowledgements
0195fb5f 337
8f97a47a 338XXX The list of people to thank goes here.
4c793fe3
FR
339
340=head1 Reporting Bugs
341
342If you find what you think is a bug, you might check the articles
343recently posted to the comp.lang.perl.misc newsgroup and the perl
344bug database at http://rt.perl.org/perlbug/ . There may also be
345information at http://www.perl.org/ , the Perl Home Page.
346
347If you believe you have an unreported bug, please run the B<perlbug>
348program included with your release. Be sure to trim your bug down
349to a tiny but sufficient test case. Your bug report, along with the
350output of C<perl -V>, will be sent off to perlbug@perl.org to be
351analysed by the Perl porting team.
352
353If the bug you are reporting has security implications, which make it
354inappropriate to send to a publicly archived mailing list, then please send
ee0887a9 355it to perl5-security-report@perl.org. This points to a closed subscription
4c793fe3
FR
356unarchived mailing list, which includes all the core committers, who be able
357to help assess the impact of issues, figure out a resolution, and help
358co-ordinate the release of patches to mitigate or fix the problem across all
ee0887a9 359platforms on which Perl is supported. Please only use this address for
4c793fe3
FR
360security issues in the Perl core, not for modules independently
361distributed on CPAN.
362
363=head1 SEE ALSO
364
365The F<Changes> file for an explanation of how to view exhaustive details
366on what changed.
367
368The F<INSTALL> file for how to build Perl.
369
370The F<README> file for general stuff.
371
372The F<Artistic> and F<Copying> files for copyright information.
373
374=cut