This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
fix CPAN.pm test broken by hotfixes
[perl5.git] / Porting / perldelta_template.pod
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
42a0894d
NC
44XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
45go here, in a list ordered by distribution name. Minimally it should be the
46module version, but it's more useful to the end user to give a paragraph's
47summary of the module's changes. In an ideal world, dual-life modules would
48have a F<Changes> file that could be cribbed.
57b3b745
DM
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
60984f2f
DG
72XXX If Module::CoreList is updated, generate this section using
73F<Porting/corelist-perldelta.pl>
74
57b3b745
DM
75=over 4
76
77=item C<XXX>
78
79XXX
80
81=back
82
83=head1 Utility Changes
84
85XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go
86here. Most of these are built within the directories F<utils> and F<x2p>.
87
88=over 4
89
90=item F<XXX>
91
92XXX
93
94=back
95
96=head1 New Documentation
97
98XXX Changes which create B<new> files in F<pod/> go here.
99
100=over 4
101
102=item L<XXX>
103
104XXX
105
106=back
107
108=head1 Changes to Existing Documentation
109
110XXX Changes which significantly change existing files in F<pod/> go here.
111Any changes to F<pod/perldiag.pod> should go in L</New or Changed Diagnostics>.
112
113
114=head1 Performance Enhancements
115
116XXX Changes which enhance performance without changing behaviour go here. There
117may well be none in a stable release.
118
119=over 4
120
121=item *
122
123XXX
124
125=back
126
127=head1 Installation and Configuration Improvements
128
129XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
130go here.
131
132=head2 Configuration improvements
133
134XXX
135
136=head2 Compilation improvements
137
138XXX
139
140=head2 Platform Specific Changes
141
142=over 4
143
144=item XXX-some-platform
145
146XXX
147
148=back
149
150=head1 Selected Bug Fixes
151
152XXX Important bug fixes in the core language are summarised here.
153Bug fixes in files in F<ext/> and F<lib/> are best summarised in
154L</Modules and Pragmata>.
155
156=over 4
157
158=item *
159
160XXX
161
162=back
163
164=head1 New or Changed Diagnostics
165
166XXX New or changed warnings emitted by the core's C<C> code go here.
167
168=over 4
169
170=item C<XXX>
171
172XXX
173
174=back
175
176=head1 Changed Internals
177
178XXX Changes which affect the interface available to C<XS> code go here.
179
180=over 4
181
182=item *
183
184XXX
185
186=back
187
188=head1 New Tests
189
190XXX Changes which create B<new> files in F<t/> go here. Changes to
191existing files in F<t/> aren't worth summarising, although the bugs that
192they represent may be.
193
194=over 4
195
196=item F<XXX>
197
198XXX
199
200=back
201
202=head1 Known Problems
203
204XXX Descriptions of platform agnostic bugs we know we can't fix go here. Any
205tests that had to be C<TODO>ed for the release would be noted here, unless
206they were specific to a particular platform (see below).
207
208This is a list of some significant unfixed bugs, which are regressions
209from either 5.XXX.XXX or 5.XXX.XXX.
210
211=over 4
212
213=item *
214
215XXX
216
217=back
218
219=head1 Deprecations
220
221XXX Add any new known deprecations here.
222
223The following items are now deprecated.
224
225=over 4
226
227=item *
228
229XXX
230
231=back
232
233=head1 Platform Specific Notes
234
235XXX Any changes specific to a particular platform. VMS and Win32 are the usual
236stars here. It's probably best to group changes under the same section layout
237as the main perldelta
238
345e2394 239=head1 Obituary
57b3b745
DM
240
241XXX If any significant core contributor has died, we've added a short obituary
242here.
243
244=head1 Acknowledgements
245
246XXX The list of people to thank goes here.
247
248
249=head1 Reporting Bugs
250
251If you find what you think is a bug, you might check the articles
252recently posted to the comp.lang.perl.misc newsgroup and the perl
253bug database at http://rt.perl.org/perlbug/ . There may also be
254information at http://www.perl.org/ , the Perl Home Page.
255
256If you believe you have an unreported bug, please run the B<perlbug>
257program included with your release. Be sure to trim your bug down
258to a tiny but sufficient test case. Your bug report, along with the
259output of C<perl -V>, will be sent off to perlbug@perl.org to be
260analysed by the Perl porting team.
261
262If the bug you are reporting has security implications, which make it
263inappropriate to send to a publicly archived mailing list, then please send
264it to perl5-security-report@perl.org. This points to a closed subscription
265unarchived mailing list, which includes all the core committers, who be able
266to help assess the impact of issues, figure out a resolution, and help
267co-ordinate the release of patches to mitigate or fix the problem across all
268platforms on which Perl is supported. Please only use this address for
269security issues in the Perl core, not for modules independently
270distributed on CPAN.
271
272=head1 SEE ALSO
273
274The F<Changes> file for an explanation of how to view exhaustive details
275on what changed.
276
277The F<INSTALL> file for how to build Perl.
278
279The F<README> file for general stuff.
280
281The F<Artistic> and F<Copying> files for copyright information.
282
283=cut