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