This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
minor improvements to git-deltatool
[perl5.git] / Porting / perldelta_template.pod
CommitLineData
bc7f466f
DM
1=encoding utf8
2
57b3b745
DM
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.XXX.XXX
9
10=head1 DESCRIPTION
11
12This document describes differences between the 5.XXX.XXX release and
13the 5.XXX.XXX release.
14
15If you are upgrading from an earlier release such as 5.XXX.XXX, first read
337e2241
RGS
16L<perl5XXXdelta>, which describes differences between 5.XXX.XXX and
175.XXX.XXX.
57b3b745
DM
18
19=head1 Notice
20
21XXX Any important notices here
22
23=head1 Incompatible Changes
24
25XXX For a release on a stable branch, this section aspires to be:
26
27 There are no changes intentionally incompatible with 5.XXX.XXX. If any
28 exist, they are bugs and reports are welcome.
29
30
31=head1 Core Enhancements
32
33XXX New core language features go here. Summarise user-visible core language
34enhancements. Particularly prominent performance optimisations could go
35here, but most should go in the L</Performance Enhancements> section.
36
37=head1 New Platforms
38
39XXX List any platforms that this version of perl compiles on, that previous
40versions did not. These will either be enabled by new files in the F<hints/>
41directories, or new subdirectories and F<README> files at the top level of the
42source tree.
43
44=head1 Modules and Pragmata
45
42a0894d 46XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
88e14305
DG
47go here. If Module::CoreList is updated, generate an initial draft of the
48following sections using F<Porting/corelist-perldelta.pl>, which prints stub
49entries to STDOUT. Results can be pasted in place of the '=head2' entries
50below. A paragraph summary for important changes should then be added by hand.
51In an ideal world, dual-life modules would have a F<Changes> file that could be
52cribbed.
57b3b745
DM
53
54=head2 New Modules and Pragmata
55
57b3b745
DM
56=head2 Pragmata Changes
57
57b3b745
DM
58=head2 Updated Modules
59
88e14305 60=head2 Removed Modules and Pragmata
57b3b745
DM
61
62=head1 Utility Changes
63
64XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go
65here. Most of these are built within the directories F<utils> and F<x2p>.
66
67=over 4
68
69=item F<XXX>
70
71XXX
72
73=back
74
75=head1 New Documentation
76
77XXX Changes which create B<new> files in F<pod/> go here.
78
79=over 4
80
81=item L<XXX>
82
83XXX
84
85=back
86
87=head1 Changes to Existing Documentation
88
89XXX Changes which significantly change existing files in F<pod/> go here.
90Any changes to F<pod/perldiag.pod> should go in L</New or Changed Diagnostics>.
91
92
93=head1 Performance Enhancements
94
95XXX Changes which enhance performance without changing behaviour go here. There
96may well be none in a stable release.
97
98=over 4
99
100=item *
101
102XXX
103
104=back
105
106=head1 Installation and Configuration Improvements
107
108XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
109go here.
110
111=head2 Configuration improvements
112
113XXX
114
115=head2 Compilation improvements
116
117XXX
118
119=head2 Platform Specific Changes
120
121=over 4
122
123=item XXX-some-platform
124
125XXX
126
127=back
128
129=head1 Selected Bug Fixes
130
131XXX Important bug fixes in the core language are summarised here.
132Bug fixes in files in F<ext/> and F<lib/> are best summarised in
133L</Modules and Pragmata>.
134
135=over 4
136
137=item *
138
139XXX
140
141=back
142
143=head1 New or Changed Diagnostics
144
145XXX New or changed warnings emitted by the core's C<C> code go here.
146
147=over 4
148
149=item C<XXX>
150
151XXX
152
153=back
154
155=head1 Changed Internals
156
157XXX Changes which affect the interface available to C<XS> code go here.
158
159=over 4
160
161=item *
162
163XXX
164
165=back
166
167=head1 New Tests
168
169XXX Changes which create B<new> files in F<t/> go here. Changes to
170existing files in F<t/> aren't worth summarising, although the bugs that
171they represent may be.
172
173=over 4
174
175=item F<XXX>
176
177XXX
178
179=back
180
181=head1 Known Problems
182
183XXX Descriptions of platform agnostic bugs we know we can't fix go here. Any
184tests that had to be C<TODO>ed for the release would be noted here, unless
185they were specific to a particular platform (see below).
186
187This is a list of some significant unfixed bugs, which are regressions
188from either 5.XXX.XXX or 5.XXX.XXX.
189
190=over 4
191
192=item *
193
194XXX
195
196=back
197
198=head1 Deprecations
199
200XXX Add any new known deprecations here.
201
202The following items are now deprecated.
203
204=over 4
205
206=item *
207
208XXX
209
210=back
211
212=head1 Platform Specific Notes
213
214XXX Any changes specific to a particular platform. VMS and Win32 are the usual
215stars here. It's probably best to group changes under the same section layout
216as the main perldelta
217
345e2394 218=head1 Obituary
57b3b745
DM
219
220XXX If any significant core contributor has died, we've added a short obituary
221here.
222
223=head1 Acknowledgements
224
225XXX The list of people to thank goes here.
226
227
228=head1 Reporting Bugs
229
230If you find what you think is a bug, you might check the articles
231recently posted to the comp.lang.perl.misc newsgroup and the perl
232bug database at http://rt.perl.org/perlbug/ . There may also be
233information at http://www.perl.org/ , the Perl Home Page.
234
235If you believe you have an unreported bug, please run the B<perlbug>
236program included with your release. Be sure to trim your bug down
237to a tiny but sufficient test case. Your bug report, along with the
238output of C<perl -V>, will be sent off to perlbug@perl.org to be
239analysed by the Perl porting team.
240
241If the bug you are reporting has security implications, which make it
242inappropriate to send to a publicly archived mailing list, then please send
243it to perl5-security-report@perl.org. This points to a closed subscription
244unarchived mailing list, which includes all the core committers, who be able
245to help assess the impact of issues, figure out a resolution, and help
246co-ordinate the release of patches to mitigate or fix the problem across all
247platforms on which Perl is supported. Please only use this address for
248security issues in the Perl core, not for modules independently
249distributed on CPAN.
250
251=head1 SEE ALSO
252
253The F<Changes> file for an explanation of how to view exhaustive details
254on what changed.
255
256The F<INSTALL> file for how to build Perl.
257
258The F<README> file for general stuff.
259
260The F<Artistic> and F<Copying> files for copyright information.
261
262=cut