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