This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
cb99f64bab5cfa06e70c287cac87c47c0639c516
[perl5.git] / pod / perldelta.pod
1 =encoding utf8
2
3 =head1 NAME
4
5 [ this is a template for a new perldelta file.  Any text flagged as XXX needs
6 to be processed before release. ]
7
8 perldelta - what is new for perl v5.19.1
9
10 =head1 DESCRIPTION
11
12 This document describes differences between the 5.19.0 release and the 5.19.1
13 release.
14
15 =head1 Notice
16
17 XXX Any important notices here
18
19 =head1 Core Enhancements
20
21 XXX New core language features go here.  Summarize user-visible core language
22 enhancements.  Particularly prominent performance optimisations could go
23 here, but most should go in the L</Performance Enhancements> section.
24
25 [ List each enhancement as a =head2 entry ]
26
27 =head1 Security
28
29 XXX Any security-related notices go here.  In particular, any security
30 vulnerabilities closed should be noted here rather than in the
31 L</Selected Bug Fixes> section.
32
33 [ List each security issue as a =head2 entry ]
34
35 =head1 Incompatible Changes
36
37 XXX For a release on a stable branch, this section aspires to be:
38
39     There are no changes intentionally incompatible with 5.XXX.XXX
40     If any exist, they are bugs, and we request that you submit a
41     report.  See L</Reporting Bugs> below.
42
43 [ List each incompatible change as a =head2 entry ]
44
45 =head1 Deprecations
46
47 XXX Any deprecated features, syntax, modules etc. should be listed here.
48
49 =head2 Module removals
50
51 XXX Remove this section if inapplicable.
52
53 The following modules will be removed from the core distribution in a future
54 release, and will at that time need to be installed from CPAN. Distributions
55 on CPAN which require these modules will need to list them as prerequisites.
56
57 The core versions of these modules will now issue C<"deprecated">-category
58 warnings to alert you to this fact. To silence these deprecation warnings,
59 install the modules in question from CPAN.
60
61 Note that these are (with rare exceptions) fine modules that you are encouraged
62 to continue to use. Their disinclusion from core primarily hinges on their
63 necessity to bootstrapping a fully functional, CPAN-capable Perl installation,
64 not usually on concerns over their design.
65
66 XXX Note that deprecated modules should be listed here even if they are listed
67 as an updated module in the L</Modules and Pragmata> section.
68
69 =over
70
71 =item *
72
73 ...
74
75 =back
76
77 [ List each other deprecation as a =head2 entry ]
78
79 =head1 Performance Enhancements
80
81 XXX Changes which enhance performance without changing behaviour go here.
82 There may well be none in a stable release.
83
84 [ List each enhancement as a =item entry ]
85
86 =over 4
87
88 =item *
89
90 XXX
91
92 =back
93
94 =head1 Modules and Pragmata
95
96 XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
97 go here.  If Module::CoreList is updated, generate an initial draft of the
98 following sections using F<Porting/corelist-perldelta.pl>, which prints stub
99 entries to STDOUT.  Results can be pasted in place of the '=head2' entries
100 below.  A paragraph summary for important changes should then be added by hand.
101 In an ideal world, dual-life modules would have a F<Changes> file that could be
102 cribbed.
103
104 [ Within each section, list entries as a =item entry ]
105
106 =head2 New Modules and Pragmata
107
108 =over 4
109
110 =item *
111
112 XXX
113
114 =back
115
116 =head2 Updated Modules and Pragmata
117
118 =over 4
119
120 =item *
121
122 Test::Harness has been upgraded from version 3.26 to 3.28
123
124 Memory usage is dramatically reduced. t/harness now uses about 10% of the
125 memory used by 3.26 and earlier.
126
127 C<PERL5LIB> is always propagated to a test's C<@INC>, even under C<-T>.
128
129 =back
130
131 =head2 Removed Modules and Pragmata
132
133 =over 4
134
135 =item *
136
137 XXX
138
139 =back
140
141 =head1 Documentation
142
143 XXX Changes to files in F<pod/> go here.  Consider grouping entries by
144 file and be sure to link to the appropriate page, e.g. L<perlfunc>.
145
146 =head2 New Documentation
147
148 XXX Changes which create B<new> files in F<pod/> go here.
149
150 =head3 L<XXX>
151
152 XXX Description of the purpose of the new file here
153
154 =head2 Changes to Existing Documentation
155
156 XXX Changes which significantly change existing files in F<pod/> go here.
157 However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
158 section.
159
160 =head3 L<XXX>
161
162 =over 4
163
164 =item *
165
166 XXX Description of the change here
167
168 =back
169
170 =head1 Diagnostics
171
172 The following additions or changes have been made to diagnostic output,
173 including warnings and fatal error messages.  For the complete list of
174 diagnostic messages, see L<perldiag>.
175
176 XXX New or changed warnings emitted by the core's C<C> code go here.  Also
177 include any changes in L<perldiag> that reconcile it to the C<C> code.
178
179 =head2 New Diagnostics
180
181 XXX Newly added diagnostic messages go under here, separated into New Errors
182 and New Warnings
183
184 =head3 New Errors
185
186 =over 4
187
188 =item *
189
190 XXX L<message|perldiag/"message">
191
192 =back
193
194 =head3 New Warnings
195
196 =over 4
197
198 =item *
199
200 XXX L<message|perldiag/"message">
201
202 =back
203
204 =head2 Changes to Existing Diagnostics
205
206 XXX Changes (i.e. rewording) of diagnostic messages go here
207
208 =over 4
209
210 =item *
211
212 XXX Describe change here
213
214 =back
215
216 =head1 Utility Changes
217
218 XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here.
219 Most of these are built within the directories F<utils> and F<x2p>.
220
221 [ List utility changes as a =head3 entry for each utility and =item
222 entries for each change
223 Use L<XXX> with program names to get proper documentation linking. ]
224
225 =head3 L<XXX>
226
227 =over 4
228
229 =item *
230
231 XXX
232
233 =back
234
235 =head1 Configuration and Compilation
236
237 XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
238 go here.  Any other changes to the Perl build process should be listed here.
239 However, any platform-specific changes should be listed in the
240 L</Platform Support> section, instead.
241
242 [ List changes as a =item entry ].
243
244 =over 4
245
246 =item *
247
248 XXX
249
250 =back
251
252 =head1 Testing
253
254 XXX Any significant changes to the testing of a freshly built perl should be
255 listed here.  Changes which create B<new> files in F<t/> go here as do any
256 large changes to the testing harness (e.g. when parallel testing was added).
257 Changes to existing files in F<t/> aren't worth summarizing, although the bugs
258 that they represent may be covered elsewhere.
259
260 [ List each test improvement as a =item entry ]
261
262 =over 4
263
264 =item *
265
266 XXX
267
268 =back
269
270 =head1 Platform Support
271
272 XXX Any changes to platform support should be listed in the sections below.
273
274 [ Within the sections, list each platform as a =item entry with specific
275 changes as paragraphs below it. ]
276
277 =head2 New Platforms
278
279 XXX List any platforms that this version of perl compiles on, that previous
280 versions did not.  These will either be enabled by new files in the F<hints/>
281 directories, or new subdirectories and F<README> files at the top level of the
282 source tree.
283
284 =over 4
285
286 =item XXX-some-platform
287
288 XXX
289
290 =back
291
292 =head2 Discontinued Platforms
293
294 XXX List any platforms that this version of perl no longer compiles on.
295
296 =over 4
297
298 =item XXX-some-platform
299
300 XXX
301
302 =back
303
304 =head2 Platform-Specific Notes
305
306 XXX List any changes for specific platforms.  This could include configuration
307 and compilation changes or changes in portability/compatibility.  However,
308 changes within modules for platforms should generally be listed in the
309 L</Modules and Pragmata> section.
310
311 =over 4
312
313 =item XXX-some-platform
314
315 XXX
316
317 =back
318
319 =head1 Internal Changes
320
321 XXX Changes which affect the interface available to C<XS> code go here.  Other
322 significant internal changes for future core maintainers should be noted as
323 well.
324
325 [ List each change as a =item entry ]
326
327 =over 4
328
329 =item *
330
331 XXX
332
333 =back
334
335 =head1 Selected Bug Fixes
336
337 XXX Important bug fixes in the core language are summarized here.  Bug fixes in
338 files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>.
339
340 [ List each fix as a =item entry ]
341
342 =over 4
343
344 =item *
345
346 XXX
347
348 =back
349
350 =head1 Known Problems
351
352 XXX Descriptions of platform agnostic bugs we know we can't fix go here.  Any
353 tests that had to be C<TODO>ed for the release would be noted here.  Unfixed
354 platform specific bugs also go here.
355
356 [ List each fix as a =item entry ]
357
358 =over 4
359
360 =item *
361
362 XXX
363
364 =back
365
366 =head1 Obituary
367
368 XXX If any significant core contributor has died, we've added a short obituary
369 here.
370
371 =head1 Acknowledgements
372
373 XXX Generate this with:
374
375   perl Porting/acknowledgements.pl v5.19.1..HEAD
376
377 =head1 Reporting Bugs
378
379 If you find what you think is a bug, you might check the articles recently
380 posted to the comp.lang.perl.misc newsgroup and the perl bug database at
381 http://rt.perl.org/perlbug/ .  There may also be information at
382 http://www.perl.org/ , the Perl Home Page.
383
384 If you believe you have an unreported bug, please run the L<perlbug> program
385 included with your release.  Be sure to trim your bug down to a tiny but
386 sufficient test case.  Your bug report, along with the output of C<perl -V>,
387 will be sent off to perlbug@perl.org to be analysed by the Perl porting team.
388
389 If the bug you are reporting has security implications, which make it
390 inappropriate to send to a publicly archived mailing list, then please send it
391 to perl5-security-report@perl.org.  This points to a closed subscription
392 unarchived mailing list, which includes all the core committers, who will be
393 able to help assess the impact of issues, figure out a resolution, and help
394 co-ordinate the release of patches to mitigate or fix the problem across all
395 platforms on which Perl is supported.  Please only use this address for
396 security issues in the Perl core, not for modules independently distributed on
397 CPAN.
398
399 =head1 SEE ALSO
400
401 The F<Changes> file for an explanation of how to view exhaustive details on
402 what changed.
403
404 The F<INSTALL> file for how to build Perl.
405
406 The F<README> file for general stuff.
407
408 The F<Artistic> and F<Copying> files for copyright information.
409
410 =cut